<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow: net_flow/asio/node.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_460afd45d0ec637b1427e0e06a6fbcf7.html">net_flow</a></li><li class="navelem"><a class="el" href="dir_183f5ca7bfa2ee923b1b08301562c36a.html">asio</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">node.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="asio_2node_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="net__flow__fwd_8hpp.html">flow/net_flow/net_flow_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="node_8hpp.html">flow/net_flow/node.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &quot;<a class="code" href="asio_2peer__socket_8hpp.html">flow/net_flow/asio/peer_socket.hpp</a>&quot;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &quot;<a class="code" href="asio_2server__socket_8hpp.html">flow/net_flow/asio/server_socket.hpp</a>&quot;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#include &quot;<a class="code" href="sched__task_8hpp.html">flow/util/sched_task.hpp</a>&quot;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span> </div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceflow_1_1net__flow_1_1asio.html">flow::net_flow::asio</a></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span>{<span class="comment"></span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment">/**</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment"> * A subclass of net_flow::Node that adds the ability to easily and directly use `net_flow` sockets in general</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"> * boost.asio event loops.</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"> *</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment"> * net_flow::Node, the superclass, provides the vast bulk of the functionality in this library, but</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> * the sockets it generates directly or indirectly (net_flow::Peer_socket, net_flow::Server_socket) cannot be used</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> * directly in a boost.asio event loop (see reference below for background).  It is possible to use the</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> * vanilla net_flow::Node, etc., with *any* asynchronous event loop (boost.asio or native `epoll` or `select()`...) --</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> * notably by using a glue socket, as explained in Event_set doc header.  However, for those using the boost.asio</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> * `io_context` as the app&#39;s core main loop, this is not as easy as what one might desire.  (Side note:</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> * I personally strongly recommend using boost.asio event loops instead of rolling one&#39;s own or the many alternatives</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> * I have seen.  It is also on its way to ending up in the C++ standard library.  Lastly, such a loop is used</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> * internally to implement `net_flow`, so you know I like it, for what that&#39;s worth.)</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> *</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> * Basically, if you use this asio::Node instead of net_flow::Node, then you get everything in the latter plus</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> * the ability to use Flow-protocol sockets `{Server|Peer}_socket` with boost.asio as easily as and similarly to how</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> * one uses `boost::asio::ip::tcp::acceptor::async_*()` and `boost::asio::ip::tcp::socket::async_*()`, respectively.</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> *</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> * The usage pattern is simple, assuming you understand tha basics of net_flow::Node, net_flow::Server_socket, and</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> * net_flow::Peer_socket -- and especially if you are familiar with boost.asio&#39;s built-in `tcp::acceptor` and</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> * `tcp::socket` (and, of course, `boost::asio::io_context` that ties them and many more I/O objects together).</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> *</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> *   - First, simply create an asio::Node using the same form of constructor as you would with net_flow::Node, plus</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> *     an arg that&#39;s a pointer to the subsequently used target boost.asio flow::util::Task_engine, which is memorized.</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> *     - All facilities from the regular net_flow::Node are available on this object (plus some minor boost.asio ones).</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> *   - Upon obtaining a net_flow::Server_socket::Ptr via listen(), cast it to its true polymorphic</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> *     equivalent asio::Server_socket::Ptr, via convenience method net_flow::asio::Server_socket::cast():</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> *     `auto serv = asio::Server_socket::cast(node.listen(...));`.</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"> *     - All facilities from the superclass net_flow::Server_socket are available (plus some minor boost.asio ones).</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"> *   - Similarly cast any net_flow::Peer_socket::Ptr to `asio` equivalent for any peer socket returned</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"> *     by asio::Server_socket::accept() and asio::Node::connect() and similar.</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment"> *     - All facilities from the superclass net_flow::Peer_socket are available (plus some minor boost.asio ones).</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"> *   - All Server_socket and Peer_socket objects created by the Node subsequently will inherit the `Task_engine*`</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment"> *     supplied in Node constructor.  However, you may overwrite these (or remove them, by setting to null) at any</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"> *     time via Node::set_async_task_engine(), Server_socket::set_async_task_engine(),</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"> *     Peer_socket::set_async_task_engine().</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"> *     - The only rule is this: `net_flow::asio::X::async_task_engine()` must not be null whenever one calls</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="comment"> *       `net_flow::asio::X::async_F()`, where X is Node, Server_socket, or Peer_socket; and `async_F()` is some async</span></div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno">   67</span><span class="comment"> *       operation added on top of base class `net_flow::X` (which typically features</span></div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span><span class="comment"> *       `net_flow::X::F()` and `net_flow::X::sync_F()` -- the non-blocking and thread-blocking versions of F,</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span><span class="comment"> *       respectively).</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="comment"> *     - The automatic inheriting of `Task_engine` pointer is as follows:</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment"> *       `Node -listen-&gt; Server_socket -accept-&gt; Peer_socket &lt;-connect- Node`.</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment"> *       - For each op inside an &quot;arrow,&quot; I mean to include all forms of it</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment"> *         (`F` includes: `F()`, `sync_F()`, `async_F()`).</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment"> *       - This pattern is more practical/reasonable for us than the boost.asio pattern of each object memorizing its</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment"> *         `io_context` reference in its explicit constructor.  That is because we fully embrace the</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment"> *         factory-of-shared-pointers pattern, and boost.asio doesn&#39;t use that pattern.  We also provide an explicit</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment"> *         mutator however.</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment"> *       - We also allow for a null `Task_engine*` -- except when `async_*()` is actually performed.</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment"> *         (boost.asio I/O objects seem to require a real flow::util::Task_engine, even if not planning to do anything</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment"> *         async.  Note, though, that if you don&#39;t plan to do anything async with `net_flow`, then you can just use</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment"> *         vanilla net_flow::Node.  Bottom line, you have (on this topic) *at least* as much flexibility as with</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment"> *         boost.asio built-in I/O objects.)</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment"> *</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment"> * Having thus obtained asio::Server_socket and asio::Peer_socket objects (and assigned each their desired</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment"> * boost.asio `io_context` loop(s) -- essentially as one does with, e.g., `tcp::acceptor` and `tcp::socket`</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment"> * respectively) -- you many now use the full range of I/O operations.  Here is a bird&#39;s eye view of all operations</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment"> * available in the entire hierarchy.  Note that conceptually this is essentially identical to boost.asio `tcp`</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment"> * I/O objects, but nomenclature and API decisions are in some cases somewhat different (I contend: with good reason).</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment"> *</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment"> *   - Non-blocking operations:</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment"> *     - net_flow::Node::listen() -&gt; net_flow::Server_socket: Create an object listening for connections.</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment"> *       - Equivalent: `tcp::acceptor` constructor that takes a local endpoint arg.</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment"> *     - net_flow::Server_socket::accept() -&gt; net_flow::Peer_socket: Return a fully connected peer socket object,</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment"> *       if one is immediately ready due to the listening done so far.</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment"> *       - Equivalent: `tcp::acceptor::accept()` after ensuring `tcp::acceptor::non_blocking(true)`.</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span><span class="comment"> *         NetFlow null return value &lt;-&gt; TCP &quot;would-block&quot; error code.</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span><span class="comment"> *     - net_flow::Node::connect() -&gt; net_flow::Peer_socket: Return a connectING peer socket object immediately,</span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment"> *       as it tries to connected to the server socket on the remote side.</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment"> *       - Equivalent: `tcp::socket::connect()` after ensuring `tcp::socket::non_blocking(true)`.</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment"> *       - Variations: see also `*_with_metadata()` for an added feature without direct TCP equivalent.</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment"> *     - net_flow::Peer_socket::send(): Queue up at least 1 of the N given bytes to send to peer ASAP; or</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment"> *       indicate no bytes could be *immediately* queued.</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span><span class="comment"> *       - Equivalent: `tcp::socket::send()` after ensuring `tcp::socket::non_blocking(true)`.</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span><span class="comment"> *         NetFlow 0 return value &lt;-&gt; TCP &quot;would-block&quot; error code.</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span><span class="comment"> *     - net_flow::Peer_socket::receive(): Dequeue at least 1 of the desired N bytes earlier received from peer; or</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment"> *       indicate none were *immediately* available.</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment"> *       - Equivalent: `tcp::socket::receive()` after ensuring `tcp::socket::non_blocking(true)`.</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span><span class="comment"> *         NetFlow 0 return value &lt;-&gt; TCP &quot;would-block&quot; error code.</span></div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment"> *   - Blocking operations:</span></div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment"> *     - net_flow::Server_socket::sync_accept() -&gt; net_flow::Peer_socket: Return a fully connected peer socket object,</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span><span class="comment"> *       blocking thread if necessary to wait for a connection to come in and fully establish.</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment"> *       - Equivalent: `tcp::acceptor::accept()` after ensuring `tcp::acceptor::non_blocking(false)`.</span></div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment"> *       - Variations: optional timeout can be specified.</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span><span class="comment"> *       - Variations: `reactor_pattern` mode, where the accept() call itself is left to aftermath of sync_accept().</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment"> *     - net_flow::Node::sync_connect() -&gt; net_flow::Peer_socket: Return a connected peer socket object,</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment"> *       blocking thread as needed to reach the remote server and fully establish connection.</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span><span class="comment"> *       - Equivalent: `tcp::socket::connect()` after ensuring `tcp::socket::non_blocking(false)`.</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span><span class="comment"> *       - Variations: see also `*_with_metadata()` as above.</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span><span class="comment"> *     - net_flow::Peer_socket::sync_send(): Queue up at least 1 of the N given bytes to send to peer ASAP,</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment"> *       blocking thread if necessary to wait for this to become possible (internally, as determined by</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment"> *       such things as flow control, congestion control, buffer size limits).</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment"> *       - Equivalent: `tcp::socket::send()` after ensuring `tcp::socket::non_blocking(false)`.</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment"> *       - Variations: optional timeout can be specified.</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment"> *       - Variations: `nullptr_t` mode, where the `send()` call itself is left to aftermath of sync_send().</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment"> *     - net_flow::Peer_socket::sync_receive(): Dequeue at least 1 of the desired N bytes from peer,</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment"> *       blocking thread if necessary to wait for this to arrive from said remote peer.</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment"> *       - Equivalent: `tcp::socket::receive()` after ensuring `tcp::socket::non_blocking(false)`.</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment"> *       - Variations: optional timeout can be specified.</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment"> *       - Variations: `nullptr_t` mode, where the `receive()` call itself is left to aftermath of sync_receive().</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment"> *   - Asynchronous operations (`asio::*` classes provide these):</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment"> *     - asio::Server_socket::async_accept() -&gt; asio::Peer_socket: Obtain a fully connected peer socket object,</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment"> *       waiting as necessary in background for a connection to come in and fully establish,</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span><span class="comment"> *       then invoking user-provided callback as if by `post(io_context&amp;)`.</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment"> *       - Equivalent: `tcp::acceptor::async_accept()`.</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment"> *       - Variations: optional timeout can be specified.</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span><span class="comment"> *       - Variations: `reactor_pattern` mode, where the `accept()` call itself is left to user handler.</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment"> *     - asio::Node::async_connect() -&gt; net_flow::Peer_socket: Return a fully connected peer socket object,</span></div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment"> *       waiting as necessary in background to reach the remote server and fully establish connection,</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span><span class="comment"> *       then invoking user-provided callback as if by `post(io_context&amp;)`.</span></div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment"> *       - Equivalent: `tcp::socket::async_connect()`.</span></div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment"> *       - Variations: optional timeout can be specified.</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span><span class="comment"> *       - Variations: see also `*_with_metadata()` as above.</span></div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span><span class="comment"> *     - asio::Peer_socket::async_send(): Queue up at least 1 of the N given bytes to send to peer ASAP,</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment"> *       waiting as necessary in background for this to become possible (as explained above),</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment"> *       then invoking user-provided callback as if by `post(io_context&amp;)`.</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment"> *       - Equivalent: `tcp::socket::async_send()`.</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment"> *       - Variations: optional timeout can be specified.</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment"> *       - Variations: `nullptr_t` mode, where the `send()` call itself is left to user handler.</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment"> *     - asio::Peer_socket::async_receive(): Dequeue at least 1 of the desired N bytes from peer,</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment"> *       waiting as necessary in background for this to arrive from said remote peer,</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment"> *       then invoking user-provided callback as if by `post(io_context&amp;)`.</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment"> *       - Equivalent: `tcp::socket::async_receive()`.</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment"> *       - Variations: optional timeout can be specified.</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment"> *       - Variations: `nullptr_t` mode, where the `receive()` call itself is left to user handler.</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment"> *   - Awaiting socket events (status):</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment"> *     - Note that this is both a fundamental building block making much of the above work and simultaneously</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment"> *       best to avoid using directly.  In particular, boost.asio is (subjectively speaking) a way to write a</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span><span class="comment"> *       cleaner event loop, and &quot;Asynchronous operations&quot; above allow Flow-protocol use with boost.asio proactors.</span></div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment"> *     - Event_set::add_wanted_socket(), Event_set::remove_wanted_socket(), Event_set::swap_wanted_sockets(),</span></div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment"> *       Event_set::clear_wanted_sockets(), and related: Specify the precise socket(s) for which to check on</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment"> *       particular status; and the status(es) for which to wait (e.g., Readable, Writable, Acceptable).</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment"> *       - Equivalent (`select()`): `FD_SET()`, `FD_CLR()`, `FD_ZERO()`, etc.</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment"> *       - Equivalent (`poll()`): The input events array.</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="comment"> *     - Event_set::sync_wait(): Synchronous I/O multiplexing, with indefinite blocking or finite timeout blocking.</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment"> *       - Equivalent: `select()` with null timeout (indefinite) or non-null, non-zero timeout (finite).</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment"> *       - Equivalent: `poll()` with -1 timeout (indefinite) or positive timeout (finite).</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment"> *     - Event_set::poll(): Non-blocking I/O multiplexing, with an instant check for the socket status(es) of interest.</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="comment"> *       - Equivalent: `select()` with non-null, zero timeout.</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment"> *       - Equivalent: `poll()` with 0 timeout.</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span><span class="comment"> *     - Event_set::async_wait(): Asynchronous I/O multiplixing, like sync_wait() but waits in background and</span></div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span><span class="comment"> *       executes user-provided callback from an unspecified thread.  (A typical callback might set a `future`</span></div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="comment"> *       result; `post(io_context&amp;)` a task to some boost.asio event loop; perhaps set a flag that is</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment"> *       periodically checked by some user thread; or send a byte over some quick IPC mechanism like a POSIX</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="comment"> *       domain socket or loopback UDP socket -- or even a condition variable.)</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="comment"> *       - Equivalents: none in POSIX, that I know of.  Windows &quot;overlapped&quot; async I/O sounds vaguely like a distant</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="comment"> *         cousin.  boost.asio `tcp::socket::async_*` (`async_wait()` if relevant) can simulate</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span><span class="comment"> *         it also, but that&#39;s like using a modern PC to emulate an old graphing calculator... it&#39;s only</span></div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span><span class="comment"> *         conceivably useful if you need to work with some old-school 3rd party I/O library perhaps.</span></div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="comment"> *</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="comment"> * ### Thread safety ###</span></div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span><span class="comment"> * See net_flow::Node thread safety notes.</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span><span class="comment"> *</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span><span class="comment"> * The one exception to the &quot;concurrent write access to one Node is thread-safe without added locking&quot; is</span></div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment"> * for set_async_task_engine().  See doc headers for async_task_engine() and set_async_task_engine() for more.</span></div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span><span class="comment"> *</span></div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="comment"> * ### Thread safety of destructor ###</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span><span class="comment"> * See net_flow::Node thready safety notes.  Note, in particular, however, that as of this writing you may *not* let</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment"> * asio::Node destruct if there are outstanding `{Node|Server|Peer}_socket::async_*()` operations.  The ability to</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment"> * early-destruct during `sync_*()` does not extend to `async_*()`.</span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="comment"> *</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment"> * @see boost.asio doc: https://www.boost.org/doc/libs/1_63_0/doc/html/boost_asio.html.</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment"> * @see Superclass net_flow::Node, companion classes asio::Peer_socket and asio::Server_socket.</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="comment"> *</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span><span class="comment"> * @todo To enable reactor-style `async_*()` operations, meaning waiting for readability/writability/etc. but *not*</span></div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span><span class="comment"> * performing the actual operation before calling the user handler, we provide a `nullptr_t`-style interface;</span></div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span><span class="comment"> * like newer boost.asio versions we should deprecate this in favor of simpler `async_wait()` APIs.</span></div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span><span class="comment"> * This would apply to net_flow::asio::Peer_socket and net_flow::asio::Server_socket APIs.</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span><span class="comment"> * Similarly consider doing this for the `sync_*()` operations in the non-`asio` superclasses net_flow::Peer_socket</span></div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="comment"> * and net_flow::Server_socket.  Note that Event_set::async_wait() and Event_set::sync_wait() already exist; they</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span><span class="comment"> * are powerful but a bit complex to use in these simple situations.  Hence the following hypothetical wrappers would</span></div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span><span class="comment"> * be welcome replacements for the deprecated `nullptr_t` and &quot;reactor-style&quot; APIs in these classes:</span></div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span><span class="comment"> * `net_flow::Peer_socket::sync_wait(Event_set::Event_type)`,</span></div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span><span class="comment"> * `net_flow::asio::Peer_socket::async_wait(Event_set::Event_type)`,</span></div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span><span class="comment"> * `net_flow::Server_socket::sync_wait()`,</span></div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span><span class="comment"> * `net_flow::Server_socket::async_wait()`.  (Timeout-arg versions would be desired also, as they exist now.)</span></div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="comment"> *</span></div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span><span class="comment"> * @internal</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span><span class="comment"> *</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="comment"> * The decision to make set_async_task_engine() thread-unsafe, by refusing to put locking around internal uses of</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span><span class="comment"> * #m_target_task_engine -- and in contrast to the rest of the main classes, which are generally thread-safe in</span></div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span><span class="comment"> * this sense -- was taken for the following reasons.</span></div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span><span class="comment"> *   1. Less mandatory locking = avoids potential performance loss.</span></div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="comment"> *   2. Realistically, set_async_task_engine() is not commonly used; and if it *is* used, it&#39;s tough to contrive</span></div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span><span class="comment"> *      a situation where one needs to call it *while* other threads are carrying on async operations -- so potential</span></div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span><span class="comment"> *      performance loss would be to provide a guarantee that wouldn&#39;t be very useful.</span></div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span><span class="comment"> *   3. Furthermore, it seems wrong to encourage wildly changing around the service throughout the socket&#39;s life.</span></div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span><span class="comment"> *      Just don&#39;t.</span></div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span><span class="comment"> *</span></div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno">  219</span><span class="comment"> * There are counter-arguments.</span></div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span><span class="comment"> *   1. Saying Node is safe for concurrent access is easier and cleaner than saying that EXCEPT certain methods.</span></div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span><span class="comment"> *      - Well, that&#39;s a shame, but it&#39;s only a comment ultimately.</span></div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span><span class="comment"> *   2. If one *wanted* to use set_async_task_engine() concurrently with the methods against which it is</span></div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span><span class="comment"> *      thread-unsafe, they couldn&#39;t: async operations would require access to async_task_engine() during their</span></div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span><span class="comment"> *      background work, and there&#39;s no good way to let user lock around those parts.</span></div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span><span class="comment"> *      In other words, we&#39;re not merely leaving locking to user; no user locking solution could possibly fully work.</span></div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span><span class="comment"> *      - That&#39;s a true concern, but on balance it is defeated by reasons 2 and 3 above.  (Realistically -- doubt anyone</span></div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span><span class="comment"> *        would care; and don&#39;t want to encourage them to do strange stuff.)</span></div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span><span class="comment"> *</span></div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno">  229</span><span class="comment"> * @todo The `sync_*()` early-destruction functionality explained in &quot;Thread safety of destructor&quot; above</span></div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno">  230</span><span class="comment"> * could be extended to `async_*()`.  This is not a huge deal but would be nice for consistency.  Not allowing it</span></div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span><span class="comment"> * currently is really a result of internal implementation concerns (it is easier to not account for this corner case).</span></div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span><span class="comment"> * Alternatively, maybe we should go the other way and not support the somewhat-weird corner case in `sync_*()`.</span></div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span><span class="comment"> */</span></div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1asio_1_1Node.html">  234</a></span><span class="keyword">class </span><a class="code hl_class" href="classflow_1_1net__flow_1_1asio_1_1Node.html">Node</a> :</div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno">  235</span>  <span class="keyword">public</span> <a class="code hl_class" href="classflow_1_1net__flow_1_1Node.html">net_flow::Node</a></div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span>{</div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno">  237</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span>  <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span><span class="comment"></span> </div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span><span class="comment">   * Constructs Node.  All docs from net_flow::Node::Node super-constructor apply.</span></div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span><span class="comment">   *</span></div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span><span class="comment">   * The difference is you may supply a flow::util::Task_engine.  More details below.</span></div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span><span class="comment">   *</span></div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno">  245</span><span class="comment">   * @param logger</span></div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno">  246</span><span class="comment">   *        See net_flow::Node::Node().</span></div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno">  247</span><span class="comment">   * @param target_async_task_engine</span></div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span><span class="comment">   *        Initial value for async_task_engine().</span></div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span><span class="comment">   *        For the effect this has see async_task_engine() doc header.</span></div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span><span class="comment">   * @param low_lvl_endpoint</span></div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span><span class="comment">   *        See net_flow::Node::Node().</span></div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span><span class="comment">   * @param net_env_sim</span></div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno">  253</span><span class="comment">   *        See net_flow::Node::Node().</span></div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno">  254</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno">  255</span><span class="comment">   *        See net_flow::Node::Node().</span></div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno">  256</span><span class="comment">   * @param opts</span></div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno">  257</span><span class="comment">   *        See net_flow::Node::Node().</span></div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno">  258</span><span class="comment">   */</span></div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno">  259</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#a7db28ab33b1a9afcdcd1884e08f33bee">Node</a>(<a class="code hl_class" href="classflow_1_1log_1_1Logger.html">log::Logger</a>* logger, <a class="code hl_typedef" href="namespaceflow_1_1util.html#ac3e89a8a271b0ddc76ac2a0ce488dea4">util::Task_engine</a>* target_async_task_engine,</div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span>                <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow_1_1util.html#af1b28edb7bad743c1c77f6b982cc3196">util::Udp_endpoint</a>&amp; low_lvl_endpoint,</div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span>                <a class="code hl_class" href="classflow_1_1net__flow_1_1Net__env__simulator.html">Net_env_simulator</a>* net_env_sim = 0, <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>* err_code = 0,</div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno">  262</span>                <span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Node__options.html">Node_options</a>&amp; opts = <a class="code hl_struct" href="structflow_1_1net__flow_1_1Node__options.html">Node_options</a>());</div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno">  263</span> </div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno">  264</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno">  265</span><span class="comment"></span> </div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno">  266</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span><span class="comment">   * Pointer (possibly null) for the flow::util::Task_engine used by any coming async I/O calls and inherited by any</span></div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span><span class="comment">   * subsequently generated Server_socket and Peer_socket objects.</span></div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span><span class="comment">   *</span></div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno">  270</span><span class="comment">   * One, this is used by `Node::async_*()` I/O calls, namely Node::async_connect() and all its variants, both</span></div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span><span class="comment">   * synchronously and during the async phases of such calls, whenever placing a user-supplied handler routine</span></div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno">  272</span><span class="comment">   * onto an `Task_engine`.  Whatever async_task_engine() returns at that time is the `Task_engine` used.</span></div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span><span class="comment">   *</span></div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span><span class="comment">   * Two, when listen() creates Server_socket, or connect() creates Peer_socket, at that moment this is used.</span></div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span><span class="comment">   * (Recall: `[a]sync_connect()` and variants will all call connect() internally.)  Hence, the initial value</span></div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno">  276</span><span class="comment">   * returned by Peer_socket::async_task_engine() and Server_socket::async_task_engine() is thus inherited from</span></div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span><span class="comment">   * the factory Node&#39;s async_task_engine() result.</span></div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno">  278</span><span class="comment">   *</span></div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno">  279</span><span class="comment">   * ### Thread safety (operating on a given Node) ###</span></div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno">  280</span><span class="comment">   *</span></div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno">  281</span><span class="comment">   *   - set_async_task_engine() is the only way to change the returned value, upon Node construction.</span></div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno">  282</span><span class="comment">   *   - It is not safe to call set_async_task_engine() at the same time as async_task_engine().</span></div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno">  283</span><span class="comment">   *   - Define &quot;any Node async op&quot; as Node::async_connect() and all its variants, including actions it takes</span></div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno">  284</span><span class="comment">   *     in the background (asynchronously).</span></div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno">  285</span><span class="comment">   *     - async_task_engine() must return the same value -- and *not* null -- throughout &quot;any Node async op.&quot;</span></div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno">  286</span><span class="comment">   *   - Define &quot;any Node async inheriting op&quot; as any non-blocking Node method that creates a Peer_socket or</span></div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno">  287</span><span class="comment">   *     Server_socket (namely, connect(), listen(), and any variants).</span></div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno">  288</span><span class="comment">   *     - Note that `[a]sync_connect()` (and variants) each invokes this non-blocking connect() at the start.</span></div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno">  289</span><span class="comment">   *     - async_task_engine() must return the same value -- possibly null -- throughout &quot;any Node async inheriting</span></div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno">  290</span><span class="comment">   *       op.&quot;</span></div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno">  291</span><span class="comment">   *   - Put simply, a null `Task_engine` can be inherited by a generated socket, but a null cannot be used when</span></div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno">  292</span><span class="comment">   *     performing an async op.  Furthermore, set_async_task_engine() is unsafe through any of those and through</span></div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno">  293</span><span class="comment">   *     async_task_engine() itself.</span></div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno">  294</span><span class="comment">   *</span></div>
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno">  295</span><span class="comment">   * Informal tip: Typically you&#39;d never call set_async_task_engine(), hence there is no problem.  If you DO need to</span></div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno">  296</span><span class="comment">   * call it, even then normally it&#39;s easy to ensure one does this before any actual async calls are made.</span></div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno">  297</span><span class="comment">   * Trouble only begins if one calls set_async_task_engine() &quot;in the middle&quot; of operating the socket.</span></div>
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno">  298</span><span class="comment">   * There is no way to add outside locking to make that work, either, due to async &quot;tails&quot; of some calls.</span></div>
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno">  299</span><span class="comment">   *</span></div>
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno">  300</span><span class="comment">   * @return Null or non-null pointer to flow::util::Task_engine.</span></div>
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno">  301</span><span class="comment">   */</span></div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno">  302</span>  <a class="code hl_typedef" href="namespaceflow_1_1util.html#ac3e89a8a271b0ddc76ac2a0ce488dea4">util::Task_engine</a>* <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#a778ffa52a73f455142da9497ca10734d">async_task_engine</a>();</div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno">  303</span><span class="comment"></span> </div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno">  304</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno">  305</span><span class="comment">   * Overwrites the value to be returned by next async_task_engine().</span></div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno">  306</span><span class="comment">   *</span></div>
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno">  307</span><span class="comment">   * See async_task_engine() doc header before using this.</span></div>
<div class="line"><a id="l00308" name="l00308"></a><span class="lineno">  308</span><span class="comment">   *</span></div>
<div class="line"><a id="l00309" name="l00309"></a><span class="lineno">  309</span><span class="comment">   * @param target_async_task_engine</span></div>
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno">  310</span><span class="comment">   *        See async_task_engine().</span></div>
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno">  311</span><span class="comment">   */</span></div>
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno">  312</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#a0e6b29f0ae35a832b0c3c75cf0b577ae">set_async_task_engine</a>(<a class="code hl_typedef" href="namespaceflow_1_1util.html#ac3e89a8a271b0ddc76ac2a0ce488dea4">util::Task_engine</a>* target_async_task_engine);</div>
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno">  313</span><span class="comment"></span> </div>
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno">  314</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno">  315</span><span class="comment">   * The boost.asio asynchronous version of sync_connect(), performing any necessary wait and connection in the</span></div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno">  316</span><span class="comment">   * background, and queueing the user-provided callback on the given boost.asio flow::util::Task_engine.</span></div>
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno">  317</span><span class="comment">   * Acts just like connect() but instead of returning a connecting socket immediately, it returns and asycnhronously</span></div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno">  318</span><span class="comment">   * waits until the initial handshake either succeeds or fails, and then invokes the given callback (in manner</span></div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno">  319</span><span class="comment">   * equivalent to boost.asio `post(Task_engine&amp;)`), passing to it the connected socket or null, respectively,</span></div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno">  320</span><span class="comment">   * along with a success #Error_code or otherwise, respectively.  Additionally, you can specify a timeout; not</span></div>
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno">  321</span><span class="comment">   * completing the connection by that time is a specific #Error_code.</span></div>
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno">  322</span><span class="comment">   *</span></div>
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno">  323</span><span class="comment">   * See subtleties about connect timeouts in Node::sync_connect() doc header.</span></div>
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno">  324</span><span class="comment">   *</span></div>
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno">  325</span><span class="comment">   * The following are the possible outcomes, in ALL cases ending with an `on_result()` invocation `post()`ed</span></div>
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno">  326</span><span class="comment">   * onto `Task_engine* async_task_engine()` as follows:</span></div>
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno">  327</span><span class="comment">   * `on_result(const Error_code&amp; err_code, asio::Peer_socket::Ptr)`, with the 2 args determined as follows.</span></div>
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno">  328</span><span class="comment">   *   1. Connection succeeds before the given timeout expires (or succeeds, if no timeout given).</span></div>
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno">  329</span><span class="comment">   *      Socket is at least Writable at time of return.  The new socket and a success code are passed to</span></div>
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno">  330</span><span class="comment">   *      callback.</span></div>
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno">  331</span><span class="comment">   *   2. Connection fails before the given timeout expires (or fails, if no timeout given).</span></div>
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno">  332</span><span class="comment">   *      null is passed in, and a non-success #Error_code is set to reason for connection failure and passed in.</span></div>
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno">  333</span><span class="comment">   *      (Note that a built-in handshake timeout -- NOT the given user timeout, if any -- falls under this category.)</span></div>
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno">  334</span><span class="comment">   *      #Error_code error::Code::S_WAIT_INTERRUPTED means the wait was interrupted (similarly to POSIX&#39;s `EINTR`).</span></div>
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno">  335</span><span class="comment">   *   3. A user timeout is given, and the connection does not succeed before it expires.  Reported similarly</span></div>
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno">  336</span><span class="comment">   *      to 2, with specific code error::Code::S_WAIT_USER_TIMEOUT.</span></div>
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno">  337</span><span class="comment">   *      (Rationale: consistent with Server_socket::sync_accept(),</span></div>
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno">  338</span><span class="comment">   *      Peer_socket::sync_receive(), Peer_socket::sync_send() behavior.)</span></div>
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno">  339</span><span class="comment">   *</span></div>
<div class="line"><a id="l00340" name="l00340"></a><span class="lineno">  340</span><span class="comment">   * On success, the `asio::Peer_socket::Ptr sock` passed to `on_result()` will have</span></div>
<div class="line"><a id="l00341" name="l00341"></a><span class="lineno">  341</span><span class="comment">   * `sock-&gt;async_task_engine() == N-&gt;async_task_engine()`, where N is the current Node.  You can overwrite it</span></div>
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno">  342</span><span class="comment">   * subsequently if desired.</span></div>
<div class="line"><a id="l00343" name="l00343"></a><span class="lineno">  343</span><span class="comment">   *</span></div>
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno">  344</span><span class="comment">   * Tip: Typical types you might use for `max_wait`: `boost::chrono::milliseconds`,</span></div>
<div class="line"><a id="l00345" name="l00345"></a><span class="lineno">  345</span><span class="comment">   * `boost::chrono::seconds`, `boost::chrono::high_resolution_clock::duration`.</span></div>
<div class="line"><a id="l00346" name="l00346"></a><span class="lineno">  346</span><span class="comment">   *</span></div>
<div class="line"><a id="l00347" name="l00347"></a><span class="lineno">  347</span><span class="comment">   * Corner case: `*this` Node must exist throughout the async op, including when `on_result()` is actually</span></div>
<div class="line"><a id="l00348" name="l00348"></a><span class="lineno">  348</span><span class="comment">   * executed in the appropriate thread.</span></div>
<div class="line"><a id="l00349" name="l00349"></a><span class="lineno">  349</span><span class="comment">   *</span></div>
<div class="line"><a id="l00350" name="l00350"></a><span class="lineno">  350</span><span class="comment">   * error::Code other than success passed to `on_result()`:</span></div>
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno">  351</span><span class="comment">   * error::Code::S_WAIT_INTERRUPTED, error::Code::S_WAIT_USER_TIMEOUT, error::Code::S_NODE_NOT_RUNNING,</span></div>
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno">  352</span><span class="comment">   * error::Code::S_CANNOT_CONNECT_TO_IP_ANY, error::Code::S_OUT_OF_PORTS,</span></div>
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno">  353</span><span class="comment">   * error::Code::S_INTERNAL_ERROR_PORT_COLLISION,</span></div>
<div class="line"><a id="l00354" name="l00354"></a><span class="lineno">  354</span><span class="comment">   * error::Code::S_CONN_TIMEOUT, error::Code::S_CONN_REFUSED,</span></div>
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno">  355</span><span class="comment">   * error::Code::S_CONN_RESET_BY_OTHER_SIDE, error::Code::S_NODE_SHUTTING_DOWN,</span></div>
<div class="line"><a id="l00356" name="l00356"></a><span class="lineno">  356</span><span class="comment">   * error::Code::S_OPTION_CHECK_FAILED.</span></div>
<div class="line"><a id="l00357" name="l00357"></a><span class="lineno">  357</span><span class="comment">   *</span></div>
<div class="line"><a id="l00358" name="l00358"></a><span class="lineno">  358</span><span class="comment">   * @tparam Rep</span></div>
<div class="line"><a id="l00359" name="l00359"></a><span class="lineno">  359</span><span class="comment">   *         See `boost::chrono::duration` documentation (and see above tip).</span></div>
<div class="line"><a id="l00360" name="l00360"></a><span class="lineno">  360</span><span class="comment">   * @tparam Period</span></div>
<div class="line"><a id="l00361" name="l00361"></a><span class="lineno">  361</span><span class="comment">   *         See `boost::chrono::duration` documentation (and see above tip).</span></div>
<div class="line"><a id="l00362" name="l00362"></a><span class="lineno">  362</span><span class="comment">   * @tparam Handler</span></div>
<div class="line"><a id="l00363" name="l00363"></a><span class="lineno">  363</span><span class="comment">   *         A type such that if `Handler h`, then a function equivalent to `{ h(err_code, sock); }` can</span></div>
<div class="line"><a id="l00364" name="l00364"></a><span class="lineno">  364</span><span class="comment">   *         be `post()`ed onto an `Task_engine`, with `const Error_code&amp; err_code` and `asio::Peer_socket::Ptr sock`.</span></div>
<div class="line"><a id="l00365" name="l00365"></a><span class="lineno">  365</span><span class="comment">   * @param to</span></div>
<div class="line"><a id="l00366" name="l00366"></a><span class="lineno">  366</span><span class="comment">   *        See connect().</span></div>
<div class="line"><a id="l00367" name="l00367"></a><span class="lineno">  367</span><span class="comment">   * @param on_result</span></div>
<div class="line"><a id="l00368" name="l00368"></a><span class="lineno">  368</span><span class="comment">   *        Callback whose invocation as explained above to add to `*async_task_engine()` as if by `post()`.</span></div>
<div class="line"><a id="l00369" name="l00369"></a><span class="lineno">  369</span><span class="comment">   *        Note: Use `bind_executor(S, F)` to bind your handler to the util::Strand `S`.</span></div>
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno">  370</span><span class="comment">   * @param max_wait</span></div>
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno">  371</span><span class="comment">   *        The maximum amount of time from now to wait before giving up on the wait and invoking `on_result()`</span></div>
<div class="line"><a id="l00372" name="l00372"></a><span class="lineno">  372</span><span class="comment">   *        with a timeout error code.</span></div>
<div class="line"><a id="l00373" name="l00373"></a><span class="lineno">  373</span><span class="comment">   *        `&quot;duration&lt;Rep, Period&gt;::max()&quot;` will eliminate the time limit and cause indefinite wait</span></div>
<div class="line"><a id="l00374" name="l00374"></a><span class="lineno">  374</span><span class="comment">   *        -- however, not really, as there is a built-in connection timeout that will expire.</span></div>
<div class="line"><a id="l00375" name="l00375"></a><span class="lineno">  375</span><span class="comment">   * @param opts</span></div>
<div class="line"><a id="l00376" name="l00376"></a><span class="lineno">  376</span><span class="comment">   *        See connect().</span></div>
<div class="line"><a id="l00377" name="l00377"></a><span class="lineno">  377</span><span class="comment">   */</span></div>
<div class="line"><a id="l00378" name="l00378"></a><span class="lineno">  378</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Rep, <span class="keyword">typename</span> Period, <span class="keyword">typename</span> Handler&gt;</div>
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno">  379</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#a97d21b9a18651cd234589f3b0b6d2971">async_connect</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Remote__endpoint.html">Remote_endpoint</a>&amp; to,</div>
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno">  380</span>                     <span class="keyword">const</span> Handler&amp; on_result,</div>
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno">  381</span>                     <span class="keyword">const</span> boost::chrono::duration&lt;Rep, Period&gt;&amp; max_wait,</div>
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno">  382</span>                     <span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket__options.html">Peer_socket_options</a>* opts = 0);</div>
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno">  383</span><span class="comment"></span> </div>
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno">  384</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno">  385</span><span class="comment">   * A combination of async_connect() and connect_with_metadata() (asynchronously blocking connect, with supplied</span></div>
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno">  386</span><span class="comment">   * metadata).</span></div>
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno">  387</span><span class="comment">   *</span></div>
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno">  388</span><span class="comment">   * @tparam Rep</span></div>
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno">  389</span><span class="comment">   *         See async_connect().</span></div>
<div class="line"><a id="l00390" name="l00390"></a><span class="lineno">  390</span><span class="comment">   * @tparam Period</span></div>
<div class="line"><a id="l00391" name="l00391"></a><span class="lineno">  391</span><span class="comment">   *         See async_connect().</span></div>
<div class="line"><a id="l00392" name="l00392"></a><span class="lineno">  392</span><span class="comment">   * @tparam Handler</span></div>
<div class="line"><a id="l00393" name="l00393"></a><span class="lineno">  393</span><span class="comment">   *         See async_connect().</span></div>
<div class="line"><a id="l00394" name="l00394"></a><span class="lineno">  394</span><span class="comment">   * @param to</span></div>
<div class="line"><a id="l00395" name="l00395"></a><span class="lineno">  395</span><span class="comment">   *        See async_connect().</span></div>
<div class="line"><a id="l00396" name="l00396"></a><span class="lineno">  396</span><span class="comment">   * @param on_result</span></div>
<div class="line"><a id="l00397" name="l00397"></a><span class="lineno">  397</span><span class="comment">   *        See async_connect().</span></div>
<div class="line"><a id="l00398" name="l00398"></a><span class="lineno">  398</span><span class="comment">   * @param max_wait</span></div>
<div class="line"><a id="l00399" name="l00399"></a><span class="lineno">  399</span><span class="comment">   *        See async_connect().</span></div>
<div class="line"><a id="l00400" name="l00400"></a><span class="lineno">  400</span><span class="comment">   * @param serialized_metadata</span></div>
<div class="line"><a id="l00401" name="l00401"></a><span class="lineno">  401</span><span class="comment">   *        See connect_with_metadata().</span></div>
<div class="line"><a id="l00402" name="l00402"></a><span class="lineno">  402</span><span class="comment">   * @param opts</span></div>
<div class="line"><a id="l00403" name="l00403"></a><span class="lineno">  403</span><span class="comment">   *        See async_connect().</span></div>
<div class="line"><a id="l00404" name="l00404"></a><span class="lineno">  404</span><span class="comment">   */</span></div>
<div class="line"><a id="l00405" name="l00405"></a><span class="lineno">  405</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Rep, <span class="keyword">typename</span> Period, <span class="keyword">typename</span> Handler&gt;</div>
<div class="line"><a id="l00406" name="l00406"></a><span class="lineno">  406</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#af8ae97d499f6de21140b89218e52fc4c">async_connect_with_metadata</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Remote__endpoint.html">Remote_endpoint</a>&amp; to,</div>
<div class="line"><a id="l00407" name="l00407"></a><span class="lineno">  407</span>                                   <span class="keyword">const</span> Handler&amp; on_result,</div>
<div class="line"><a id="l00408" name="l00408"></a><span class="lineno">  408</span>                                   <span class="keyword">const</span> boost::chrono::duration&lt;Rep, Period&gt;&amp; max_wait,</div>
<div class="line"><a id="l00409" name="l00409"></a><span class="lineno">  409</span>                                   <span class="keyword">const</span> boost::asio::const_buffer&amp; serialized_metadata,</div>
<div class="line"><a id="l00410" name="l00410"></a><span class="lineno">  410</span>                                   <span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket__options.html">Peer_socket_options</a>* opts = 0);</div>
<div class="line"><a id="l00411" name="l00411"></a><span class="lineno">  411</span><span class="comment"></span> </div>
<div class="line"><a id="l00412" name="l00412"></a><span class="lineno">  412</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00413" name="l00413"></a><span class="lineno">  413</span><span class="comment">   * Equivalent to `async_connect(to, on_result, duration::max(), opts)`; i.e., async_connect()</span></div>
<div class="line"><a id="l00414" name="l00414"></a><span class="lineno">  414</span><span class="comment">   * with no user timeout.</span></div>
<div class="line"><a id="l00415" name="l00415"></a><span class="lineno">  415</span><span class="comment">   *</span></div>
<div class="line"><a id="l00416" name="l00416"></a><span class="lineno">  416</span><span class="comment">   * @tparam Handler</span></div>
<div class="line"><a id="l00417" name="l00417"></a><span class="lineno">  417</span><span class="comment">   *         See other async_connect().</span></div>
<div class="line"><a id="l00418" name="l00418"></a><span class="lineno">  418</span><span class="comment">   * @param to</span></div>
<div class="line"><a id="l00419" name="l00419"></a><span class="lineno">  419</span><span class="comment">   *        See other async_connect().</span></div>
<div class="line"><a id="l00420" name="l00420"></a><span class="lineno">  420</span><span class="comment">   * @param on_result</span></div>
<div class="line"><a id="l00421" name="l00421"></a><span class="lineno">  421</span><span class="comment">   *        See other async_connect().</span></div>
<div class="line"><a id="l00422" name="l00422"></a><span class="lineno">  422</span><span class="comment">   * @param opts</span></div>
<div class="line"><a id="l00423" name="l00423"></a><span class="lineno">  423</span><span class="comment">   *        See other async_connect().</span></div>
<div class="line"><a id="l00424" name="l00424"></a><span class="lineno">  424</span><span class="comment">   */</span></div>
<div class="line"><a id="l00425" name="l00425"></a><span class="lineno">  425</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handler&gt;</div>
<div class="line"><a id="l00426" name="l00426"></a><span class="lineno">  426</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#a97d21b9a18651cd234589f3b0b6d2971">async_connect</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Remote__endpoint.html">Remote_endpoint</a>&amp; to,</div>
<div class="line"><a id="l00427" name="l00427"></a><span class="lineno">  427</span>                     <span class="keyword">const</span> Handler&amp; on_result,</div>
<div class="line"><a id="l00428" name="l00428"></a><span class="lineno">  428</span>                     <span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket__options.html">Peer_socket_options</a>* opts = 0);</div>
<div class="line"><a id="l00429" name="l00429"></a><span class="lineno">  429</span><span class="comment"></span> </div>
<div class="line"><a id="l00430" name="l00430"></a><span class="lineno">  430</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00431" name="l00431"></a><span class="lineno">  431</span><span class="comment">   * Equivalent to `async_connect_with_metadata(to, on_result, duration::max(),</span></div>
<div class="line"><a id="l00432" name="l00432"></a><span class="lineno">  432</span><span class="comment">   * serialized_metadata, opts)`; i.e., async_connect_with_metadata() with no user timeout.</span></div>
<div class="line"><a id="l00433" name="l00433"></a><span class="lineno">  433</span><span class="comment">   *</span></div>
<div class="line"><a id="l00434" name="l00434"></a><span class="lineno">  434</span><span class="comment">   * @tparam Handler</span></div>
<div class="line"><a id="l00435" name="l00435"></a><span class="lineno">  435</span><span class="comment">   *         See other async_connect_with_metadata().</span></div>
<div class="line"><a id="l00436" name="l00436"></a><span class="lineno">  436</span><span class="comment">   * @param to</span></div>
<div class="line"><a id="l00437" name="l00437"></a><span class="lineno">  437</span><span class="comment">   *        See other async_connect_with_metadata().</span></div>
<div class="line"><a id="l00438" name="l00438"></a><span class="lineno">  438</span><span class="comment">   * @param on_result</span></div>
<div class="line"><a id="l00439" name="l00439"></a><span class="lineno">  439</span><span class="comment">   *        See other async_connect_with_metadata().</span></div>
<div class="line"><a id="l00440" name="l00440"></a><span class="lineno">  440</span><span class="comment">   * @param serialized_metadata</span></div>
<div class="line"><a id="l00441" name="l00441"></a><span class="lineno">  441</span><span class="comment">   *        See other async_connect_with_metadata().</span></div>
<div class="line"><a id="l00442" name="l00442"></a><span class="lineno">  442</span><span class="comment">   * @param opts</span></div>
<div class="line"><a id="l00443" name="l00443"></a><span class="lineno">  443</span><span class="comment">   *        See other async_connect_with_metadata().</span></div>
<div class="line"><a id="l00444" name="l00444"></a><span class="lineno">  444</span><span class="comment">   */</span></div>
<div class="line"><a id="l00445" name="l00445"></a><span class="lineno">  445</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handler&gt;</div>
<div class="line"><a id="l00446" name="l00446"></a><span class="lineno">  446</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#af8ae97d499f6de21140b89218e52fc4c">async_connect_with_metadata</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Remote__endpoint.html">Remote_endpoint</a>&amp; to,</div>
<div class="line"><a id="l00447" name="l00447"></a><span class="lineno">  447</span>                                   <span class="keyword">const</span> Handler&amp; on_result,</div>
<div class="line"><a id="l00448" name="l00448"></a><span class="lineno">  448</span>                                   <span class="keyword">const</span> boost::asio::const_buffer&amp; serialized_metadata,</div>
<div class="line"><a id="l00449" name="l00449"></a><span class="lineno">  449</span>                                   <span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket__options.html">Peer_socket_options</a>* opts = 0);</div>
<div class="line"><a id="l00450" name="l00450"></a><span class="lineno">  450</span> </div>
<div class="line"><a id="l00451" name="l00451"></a><span class="lineno">  451</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00452" name="l00452"></a><span class="lineno">  452</span>  <span class="comment">// Friends.</span></div>
<div class="line"><a id="l00453" name="l00453"></a><span class="lineno">  453</span><span class="comment"></span> </div>
<div class="line"><a id="l00454" name="l00454"></a><span class="lineno">  454</span><span class="comment">  /// Peer_socket must be able to forward to async_op(), etc.</span></div>
<div class="line"><a id="l00455" name="l00455"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1asio_1_1Node.html#a62cd43d29137c6c9abc7d9dd731555f9">  455</a></span><span class="comment"></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="classflow_1_1net__flow_1_1asio_1_1Peer__socket.html">Peer_socket</a>;<span class="comment"></span></div>
<div class="line"><a id="l00456" name="l00456"></a><span class="lineno">  456</span><span class="comment">  /// Server_socket must be able to forward to async_op(), etc.</span></div>
<div class="line"><a id="l00457" name="l00457"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1asio_1_1Node.html#a2165381af6166d76afba06862c762367">  457</a></span><span class="comment"></span>  <span class="keyword">friend</span> <span class="keyword">class </span><a class="code hl_class" href="classflow_1_1net__flow_1_1asio_1_1Server__socket.html">Server_socket</a>;</div>
<div class="line"><a id="l00458" name="l00458"></a><span class="lineno">  458</span> </div>
<div class="line"><a id="l00459" name="l00459"></a><span class="lineno">  459</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00460" name="l00460"></a><span class="lineno">  460</span><span class="comment"></span> </div>
<div class="line"><a id="l00461" name="l00461"></a><span class="lineno">  461</span><span class="comment">  /// Short-hand for the `Task_engine`-compatible connect `Handler` concrete type for class-internal code.</span></div>
<div class="line"><a id="l00462" name="l00462"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1asio_1_1Node.html#a62307823b2aa4db4f6de5c0245461652">  462</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_class" href="classflow_1_1Function.html">Handler_func</a> = <a class="code hl_class" href="classflow_1_1Function.html">Function</a>&lt;void (<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>&amp; err_code, <a class="code hl_typedef" href="classflow_1_1net__flow_1_1asio_1_1Peer__socket.html#a3ee868ebd8acd1788a5bed8cf66a349e">Peer_socket::Ptr</a> new_sock)&gt;;</div>
<div class="line"><a id="l00463" name="l00463"></a><span class="lineno">  463</span> </div>
<div class="line"><a id="l00464" name="l00464"></a><span class="lineno">  464</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00465" name="l00465"></a><span class="lineno">  465</span><span class="comment"></span> </div>
<div class="line"><a id="l00466" name="l00466"></a><span class="lineno">  466</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00467" name="l00467"></a><span class="lineno">  467</span><span class="comment">   * Implements superclass API.</span></div>
<div class="line"><a id="l00468" name="l00468"></a><span class="lineno">  468</span><span class="comment">   *</span></div>
<div class="line"><a id="l00469" name="l00469"></a><span class="lineno">  469</span><span class="comment">   * @param opts</span></div>
<div class="line"><a id="l00470" name="l00470"></a><span class="lineno">  470</span><span class="comment">   *        See superclass API.</span></div>
<div class="line"><a id="l00471" name="l00471"></a><span class="lineno">  471</span><span class="comment">   * @return See superclass API.</span></div>
<div class="line"><a id="l00472" name="l00472"></a><span class="lineno">  472</span><span class="comment">   */</span></div>
<div class="line"><a id="l00473" name="l00473"></a><span class="lineno">  473</span>  <a class="code hl_class" href="classflow_1_1net__flow_1_1Peer__socket.html">net_flow::Peer_socket</a>* <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#a13e8070f5a4e4300e0138b63694884fc">sock_create</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket__options.html">Peer_socket_options</a>&amp; opts) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00474" name="l00474"></a><span class="lineno">  474</span><span class="comment"></span> </div>
<div class="line"><a id="l00475" name="l00475"></a><span class="lineno">  475</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00476" name="l00476"></a><span class="lineno">  476</span><span class="comment">   * Implements superclass API.</span></div>
<div class="line"><a id="l00477" name="l00477"></a><span class="lineno">  477</span><span class="comment">   *</span></div>
<div class="line"><a id="l00478" name="l00478"></a><span class="lineno">  478</span><span class="comment">   * @param child_sock_opts</span></div>
<div class="line"><a id="l00479" name="l00479"></a><span class="lineno">  479</span><span class="comment">   *        See superclass API.</span></div>
<div class="line"><a id="l00480" name="l00480"></a><span class="lineno">  480</span><span class="comment">   * @return See superclass API.</span></div>
<div class="line"><a id="l00481" name="l00481"></a><span class="lineno">  481</span><span class="comment">   */</span></div>
<div class="line"><a id="l00482" name="l00482"></a><span class="lineno">  482</span>  <a class="code hl_class" href="classflow_1_1net__flow_1_1Server__socket.html">net_flow::Server_socket</a>* <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#a63171653725513e198b8baf60c3c1427">serv_create</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket__options.html">Peer_socket_options</a>* child_sock_opts) <span class="keyword">override</span>;</div>
<div class="line"><a id="l00483" name="l00483"></a><span class="lineno">  483</span><span class="comment"></span> </div>
<div class="line"><a id="l00484" name="l00484"></a><span class="lineno">  484</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00485" name="l00485"></a><span class="lineno">  485</span><span class="comment">   * Implementation of core asynchronous transfer methods, namely asio::Peer_socket::async_send(),</span></div>
<div class="line"><a id="l00486" name="l00486"></a><span class="lineno">  486</span><span class="comment">   * asio::Peer_socket::async_receive(), and asio::Server_socket::async_accept(), once the asio::Node has been</span></div>
<div class="line"><a id="l00487" name="l00487"></a><span class="lineno">  487</span><span class="comment">   * obtain from socket in any one of those methods.</span></div>
<div class="line"><a id="l00488" name="l00488"></a><span class="lineno">  488</span><span class="comment">   *</span></div>
<div class="line"><a id="l00489" name="l00489"></a><span class="lineno">  489</span><span class="comment">   * It is inspired by design of net_flow::Node::sync_op().</span></div>
<div class="line"><a id="l00490" name="l00490"></a><span class="lineno">  490</span><span class="comment">   *</span></div>
<div class="line"><a id="l00491" name="l00491"></a><span class="lineno">  491</span><span class="comment">   * Note the precise nature of `on_result` (see below).</span></div>
<div class="line"><a id="l00492" name="l00492"></a><span class="lineno">  492</span><span class="comment">   *</span></div>
<div class="line"><a id="l00493" name="l00493"></a><span class="lineno">  493</span><span class="comment">   * @tparam Socket</span></div>
<div class="line"><a id="l00494" name="l00494"></a><span class="lineno">  494</span><span class="comment">   *         Underlying object of the transfer operation (asio::Peer_socket or asio::Server_socket).</span></div>
<div class="line"><a id="l00495" name="l00495"></a><span class="lineno">  495</span><span class="comment">   * @tparam Base_socket</span></div>
<div class="line"><a id="l00496" name="l00496"></a><span class="lineno">  496</span><span class="comment">   *         Superclass of `Socket`.</span></div>
<div class="line"><a id="l00497" name="l00497"></a><span class="lineno">  497</span><span class="comment">   * @tparam Non_blocking_func_ret_type</span></div>
<div class="line"><a id="l00498" name="l00498"></a><span class="lineno">  498</span><span class="comment">   *         The return type of the calling transfer operation (`size_t` or asio::Peer_socket::Ptr).</span></div>
<div class="line"><a id="l00499" name="l00499"></a><span class="lineno">  499</span><span class="comment">   * @param sock</span></div>
<div class="line"><a id="l00500" name="l00500"></a><span class="lineno">  500</span><span class="comment">   *        Socket on which user called `async_*()`.</span></div>
<div class="line"><a id="l00501" name="l00501"></a><span class="lineno">  501</span><span class="comment">   * @param non_blocking_func</span></div>
<div class="line"><a id="l00502" name="l00502"></a><span class="lineno">  502</span><span class="comment">   *        When this method believes it should attempt a non-blocking transfer op, it will execute</span></div>
<div class="line"><a id="l00503" name="l00503"></a><span class="lineno">  503</span><span class="comment">   *        `non_blocking_func(&amp;err_code)` with some `Error_code err_code` existing.</span></div>
<div class="line"><a id="l00504" name="l00504"></a><span class="lineno">  504</span><span class="comment">   *        If `non_blocking_func.empty()`, do not call `non_blocking_func()` --</span></div>
<div class="line"><a id="l00505" name="l00505"></a><span class="lineno">  505</span><span class="comment">   *        invoke `on_result()` indicating no error so far, and let</span></div>
<div class="line"><a id="l00506" name="l00506"></a><span class="lineno">  506</span><span class="comment">   *        them do actual operation, if they want; we just tell them it should be ready for them.  This is known</span></div>
<div class="line"><a id="l00507" name="l00507"></a><span class="lineno">  507</span><span class="comment">   *        as reactor pattern mode.  Otherwise, do the operation and then</span></div>
<div class="line"><a id="l00508" name="l00508"></a><span class="lineno">  508</span><span class="comment">   *        invoke `on_result()` with the resulting error code, possibly success.  This is the proactor pattern mode</span></div>
<div class="line"><a id="l00509" name="l00509"></a><span class="lineno">  509</span><span class="comment">   *        and arguably more typical.</span></div>
<div class="line"><a id="l00510" name="l00510"></a><span class="lineno">  510</span><span class="comment">   * @param would_block_ret_val</span></div>
<div class="line"><a id="l00511" name="l00511"></a><span class="lineno">  511</span><span class="comment">   *        The value that `non_blocking_func()` returns to indicate it was unable to perform the</span></div>
<div class="line"><a id="l00512" name="l00512"></a><span class="lineno">  512</span><span class="comment">   *        non-blocking operation (i.e., no data/sockets available).</span></div>
<div class="line"><a id="l00513" name="l00513"></a><span class="lineno">  513</span><span class="comment">   * @param ev_type</span></div>
<div class="line"><a id="l00514" name="l00514"></a><span class="lineno">  514</span><span class="comment">   *        Event type applicable to the type of operation this is.  See Event_set::Event_type doc header.</span></div>
<div class="line"><a id="l00515" name="l00515"></a><span class="lineno">  515</span><span class="comment">   * @param wait_until</span></div>
<div class="line"><a id="l00516" name="l00516"></a><span class="lineno">  516</span><span class="comment">   *        See `max_wait` argument on the originating `async_*()` method.  This is absolute timeout time point</span></div>
<div class="line"><a id="l00517" name="l00517"></a><span class="lineno">  517</span><span class="comment">   *        derived from it; zero-valued if no timeout.</span></div>
<div class="line"><a id="l00518" name="l00518"></a><span class="lineno">  518</span><span class="comment">   * @param on_result</span></div>
<div class="line"><a id="l00519" name="l00519"></a><span class="lineno">  519</span><span class="comment">   *        A function that will properly `post()` the original `on_result()` from the originating `async_*()` method</span></div>
<div class="line"><a id="l00520" name="l00520"></a><span class="lineno">  520</span><span class="comment">   *        onto `*async_task_engine()`.  This must be done carefully, preserving any associated executor of that</span></div>
<div class="line"><a id="l00521" name="l00521"></a><span class="lineno">  521</span><span class="comment">   *        original `on_result` handler.</span></div>
<div class="line"><a id="l00522" name="l00522"></a><span class="lineno">  522</span><span class="comment">   */</span></div>
<div class="line"><a id="l00523" name="l00523"></a><span class="lineno">  523</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Socket, <span class="keyword">typename</span> Base_socket, <span class="keyword">typename</span> Non_blocking_func_ret_type&gt;</div>
<div class="line"><a id="l00524" name="l00524"></a><span class="lineno">  524</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#a0cf22e56b3c091645154719eeb49ff4a">async_op</a>(<span class="keyword">typename</span> Socket::Ptr sock,</div>
<div class="line"><a id="l00525" name="l00525"></a><span class="lineno">  525</span>                <a class="code hl_class" href="classflow_1_1Function.html">Function</a>&lt;Non_blocking_func_ret_type (<a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>*)&gt;&amp;&amp; non_blocking_func,</div>
<div class="line"><a id="l00526" name="l00526"></a><span class="lineno">  526</span>                Non_blocking_func_ret_type would_block_ret_val,</div>
<div class="line"><a id="l00527" name="l00527"></a><span class="lineno">  527</span>                <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Event__set.html#a19cc3a286c8a11c986d2a59ec1e39a71">Event_set::Event_type</a> ev_type,</div>
<div class="line"><a id="l00528" name="l00528"></a><span class="lineno">  528</span>                <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">Fine_time_pt</a>&amp; wait_until,</div>
<div class="line"><a id="l00529" name="l00529"></a><span class="lineno">  529</span>                <a class="code hl_class" href="classflow_1_1Function.html">Function</a>&lt;<span class="keywordtype">void</span> (<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>&amp;, Non_blocking_func_ret_type)&gt;&amp;&amp; on_result);</div>
<div class="line"><a id="l00530" name="l00530"></a><span class="lineno">  530</span><span class="comment"></span> </div>
<div class="line"><a id="l00531" name="l00531"></a><span class="lineno">  531</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00532" name="l00532"></a><span class="lineno">  532</span><span class="comment">   * Implementation core of `async_connect*()` that gets rid of templated or missing arguments thereof.</span></div>
<div class="line"><a id="l00533" name="l00533"></a><span class="lineno">  533</span><span class="comment">   *</span></div>
<div class="line"><a id="l00534" name="l00534"></a><span class="lineno">  534</span><span class="comment">   * E.g., the API would wrap this and supply a Fine_duration instead of generic `duration`; and supply</span></div>
<div class="line"><a id="l00535" name="l00535"></a><span class="lineno">  535</span><span class="comment">   * `Fine_duration::max()` if user omitted the timeout argument; and convert a generic function object</span></div>
<div class="line"><a id="l00536" name="l00536"></a><span class="lineno">  536</span><span class="comment">   * into a concrete `Function&lt;&gt;` object.  Code bloat and possible circular definition issues are among the</span></div>
<div class="line"><a id="l00537" name="l00537"></a><span class="lineno">  537</span><span class="comment">   * reasons for this &quot;de-templating&quot; pattern.</span></div>
<div class="line"><a id="l00538" name="l00538"></a><span class="lineno">  538</span><span class="comment">   *</span></div>
<div class="line"><a id="l00539" name="l00539"></a><span class="lineno">  539</span><span class="comment">   * @param to</span></div>
<div class="line"><a id="l00540" name="l00540"></a><span class="lineno">  540</span><span class="comment">   *        See connect().</span></div>
<div class="line"><a id="l00541" name="l00541"></a><span class="lineno">  541</span><span class="comment">   * @param max_wait</span></div>
<div class="line"><a id="l00542" name="l00542"></a><span class="lineno">  542</span><span class="comment">   *        See the public `async_connect(timeout)`.  `&quot;duration&lt;Rep, Period&gt;::max()&quot;` maps to the value</span></div>
<div class="line"><a id="l00543" name="l00543"></a><span class="lineno">  543</span><span class="comment">   *        `Fine_duration::max()` for this argument.</span></div>
<div class="line"><a id="l00544" name="l00544"></a><span class="lineno">  544</span><span class="comment">   * @param serialized_metadata</span></div>
<div class="line"><a id="l00545" name="l00545"></a><span class="lineno">  545</span><span class="comment">   *        See connect_with_metadata().</span></div>
<div class="line"><a id="l00546" name="l00546"></a><span class="lineno">  546</span><span class="comment">   * @param opts</span></div>
<div class="line"><a id="l00547" name="l00547"></a><span class="lineno">  547</span><span class="comment">   *        See connect().</span></div>
<div class="line"><a id="l00548" name="l00548"></a><span class="lineno">  548</span><span class="comment">   * @param on_result</span></div>
<div class="line"><a id="l00549" name="l00549"></a><span class="lineno">  549</span><span class="comment">   *        `handler_func(on_result)`, where `on_result` is the user&#39;s `async_*()` method arg.</span></div>
<div class="line"><a id="l00550" name="l00550"></a><span class="lineno">  550</span><span class="comment">   */</span></div>
<div class="line"><a id="l00551" name="l00551"></a><span class="lineno">  551</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#aecac8b38cd35267b1af57e2443a55ea0">async_connect_impl</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Remote__endpoint.html">Remote_endpoint</a>&amp; to, <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow.html#a48799f1263cdeedec125be51a3db2b79">Fine_duration</a>&amp; max_wait,</div>
<div class="line"><a id="l00552" name="l00552"></a><span class="lineno">  552</span>                          <span class="keyword">const</span> boost::asio::const_buffer&amp; serialized_metadata,</div>
<div class="line"><a id="l00553" name="l00553"></a><span class="lineno">  553</span>                          <span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket__options.html">Peer_socket_options</a>* opts,</div>
<div class="line"><a id="l00554" name="l00554"></a><span class="lineno">  554</span>                          <a class="code hl_class" href="classflow_1_1Function.html">Handler_func</a>&amp;&amp; on_result);</div>
<div class="line"><a id="l00555" name="l00555"></a><span class="lineno">  555</span><span class="comment"></span> </div>
<div class="line"><a id="l00556" name="l00556"></a><span class="lineno">  556</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00557" name="l00557"></a><span class="lineno">  557</span><span class="comment">   * Returns a functor that essentially performs `post()` `on_result` onto `*async_task_engine()` in a way suitable</span></div>
<div class="line"><a id="l00558" name="l00558"></a><span class="lineno">  558</span><span class="comment">   * for a boost.asio-compatible async-op.</span></div>
<div class="line"><a id="l00559" name="l00559"></a><span class="lineno">  559</span><span class="comment">   *</span></div>
<div class="line"><a id="l00560" name="l00560"></a><span class="lineno">  560</span><span class="comment">   * ### Rationale ###</span></div>
<div class="line"><a id="l00561" name="l00561"></a><span class="lineno">  561</span><span class="comment">   * See asio::Peer_socket::handler_func().</span></div>
<div class="line"><a id="l00562" name="l00562"></a><span class="lineno">  562</span><span class="comment">   *</span></div>
<div class="line"><a id="l00563" name="l00563"></a><span class="lineno">  563</span><span class="comment">   * @tparam Handler</span></div>
<div class="line"><a id="l00564" name="l00564"></a><span class="lineno">  564</span><span class="comment">   *         See async_connect().</span></div>
<div class="line"><a id="l00565" name="l00565"></a><span class="lineno">  565</span><span class="comment">   * @param on_result</span></div>
<div class="line"><a id="l00566" name="l00566"></a><span class="lineno">  566</span><span class="comment">   *        See async_connect().</span></div>
<div class="line"><a id="l00567" name="l00567"></a><span class="lineno">  567</span><span class="comment">   * @return Function to call from any context that will properly `post()` `on_result();` onto `*async_task_engine()`.</span></div>
<div class="line"><a id="l00568" name="l00568"></a><span class="lineno">  568</span><span class="comment">   */</span></div>
<div class="line"><a id="l00569" name="l00569"></a><span class="lineno">  569</span>  <span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handler&gt;</div>
<div class="line"><a id="l00570" name="l00570"></a><span class="lineno">  570</span>  <a class="code hl_class" href="classflow_1_1Function.html">Handler_func</a> <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#ad0b99ea857df0cbbf2b26f6c84e8863a">handler_func</a>(Handler&amp;&amp; on_result);</div>
<div class="line"><a id="l00571" name="l00571"></a><span class="lineno">  571</span> </div>
<div class="line"><a id="l00572" name="l00572"></a><span class="lineno">  572</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l00573" name="l00573"></a><span class="lineno">  573</span><span class="comment"></span> </div>
<div class="line"><a id="l00574" name="l00574"></a><span class="lineno">  574</span><span class="comment">  /// See async_task_engine().</span></div>
<div class="line"><a id="l00575" name="l00575"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1asio_1_1Node.html#a5b688a4071b8ad58a776de8d3816b757">  575</a></span><span class="comment"></span>  <a class="code hl_typedef" href="namespaceflow_1_1util.html#ac3e89a8a271b0ddc76ac2a0ce488dea4">util::Task_engine</a>* <a class="code hl_variable" href="classflow_1_1net__flow_1_1asio_1_1Node.html#a5b688a4071b8ad58a776de8d3816b757">m_target_task_engine</a>;</div>
<div class="line"><a id="l00576" name="l00576"></a><span class="lineno">  576</span>};</div>
<div class="line"><a id="l00577" name="l00577"></a><span class="lineno">  577</span> </div>
<div class="line"><a id="l00578" name="l00578"></a><span class="lineno">  578</span><span class="comment">// Template implementations.</span></div>
<div class="line"><a id="l00579" name="l00579"></a><span class="lineno">  579</span> </div>
<div class="line"><a id="l00580" name="l00580"></a><span class="lineno">  580</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Socket, <span class="keyword">typename</span> Base_socket, <span class="keyword">typename</span> Non_blocking_func_ret_type&gt;</div>
<div class="line"><a id="l00581" name="l00581"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1asio_1_1Node.html#a0cf22e56b3c091645154719eeb49ff4a">  581</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#a0cf22e56b3c091645154719eeb49ff4a">Node::async_op</a>(<span class="keyword">typename</span> Socket::Ptr sock,</div>
<div class="line"><a id="l00582" name="l00582"></a><span class="lineno">  582</span>                    <a class="code hl_class" href="classflow_1_1Function.html">Function</a>&lt;Non_blocking_func_ret_type (<a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>*)&gt;&amp;&amp; non_blocking_func,</div>
<div class="line"><a id="l00583" name="l00583"></a><span class="lineno">  583</span>                    Non_blocking_func_ret_type would_block_ret_val,</div>
<div class="line"><a id="l00584" name="l00584"></a><span class="lineno">  584</span>                    <a class="code hl_enumeration" href="classflow_1_1net__flow_1_1Event__set.html#a19cc3a286c8a11c986d2a59ec1e39a71">Event_set::Event_type</a> ev_type,</div>
<div class="line"><a id="l00585" name="l00585"></a><span class="lineno">  585</span>                    <span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">Fine_time_pt</a>&amp; wait_until,</div>
<div class="line"><a id="l00586" name="l00586"></a><span class="lineno">  586</span>                    <a class="code hl_class" href="classflow_1_1Function.html">Function</a>&lt;<span class="keywordtype">void</span> (<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>&amp;, Non_blocking_func_ret_type)&gt;&amp;&amp; on_result)</div>
<div class="line"><a id="l00587" name="l00587"></a><span class="lineno">  587</span>{</div>
<div class="line"><a id="l00588" name="l00588"></a><span class="lineno">  588</span>  <span class="keyword">using </span>boost::shared_ptr;</div>
<div class="line"><a id="l00589" name="l00589"></a><span class="lineno">  589</span>  <span class="keyword">using </span>boost::chrono::milliseconds;</div>
<div class="line"><a id="l00590" name="l00590"></a><span class="lineno">  590</span>  <span class="keyword">using </span>boost::chrono::round;</div>
<div class="line"><a id="l00591" name="l00591"></a><span class="lineno">  591</span>  <span class="keyword">using </span>boost::asio::bind_executor;</div>
<div class="line"><a id="l00592" name="l00592"></a><span class="lineno">  592</span> </div>
<div class="line"><a id="l00593" name="l00593"></a><span class="lineno">  593</span>  <span class="comment">// We are in user thread U != W.</span></div>
<div class="line"><a id="l00594" name="l00594"></a><span class="lineno">  594</span> </div>
<div class="line"><a id="l00595" name="l00595"></a><span class="lineno">  595</span>  <span class="comment">/* We create an Event_set with just the one event we care about (e.g., sock is Writable) and async_wait() for it.</span></div>
<div class="line"><a id="l00596" name="l00596"></a><span class="lineno">  596</span><span class="comment">   * The handler for the latter can then perform the non-blocking operation (since the socket should be ready</span></div>
<div class="line"><a id="l00597" name="l00597"></a><span class="lineno">  597</span><span class="comment">   * due to the active event).  Finally, we would place the user&#39;s async handler onto the</span></div>
<div class="line"><a id="l00598" name="l00598"></a><span class="lineno">  598</span><span class="comment">   * boost.asio Task_engine user provided to `sock`.  on_result(), by contract, shall do that if we execute it</span></div>
<div class="line"><a id="l00599" name="l00599"></a><span class="lineno">  599</span><span class="comment">   * from any context; hence when needed we simply do that below.  See our doc header for a brief note on the</span></div>
<div class="line"><a id="l00600" name="l00600"></a><span class="lineno">  600</span><span class="comment">   * requirements on on_result() which allow us to do that.</span></div>
<div class="line"><a id="l00601" name="l00601"></a><span class="lineno">  601</span><span class="comment">   *</span></div>
<div class="line"><a id="l00602" name="l00602"></a><span class="lineno">  602</span><span class="comment">   * The other cases to cover:</span></div>
<div class="line"><a id="l00603" name="l00603"></a><span class="lineno">  603</span><span class="comment">   *   - If reactor_pattern, do not perform the non-blocking op (user probably wants to do so in on_result();</span></div>
<div class="line"><a id="l00604" name="l00604"></a><span class="lineno">  604</span><span class="comment">   *     and we only inform it that they should now be able to).  non_blocking_func can be garbage.</span></div>
<div class="line"><a id="l00605" name="l00605"></a><span class="lineno">  605</span><span class="comment">   *   - If interrupted (a-la EINTR), on_result() with the error code indicating interruption, no call</span></div>
<div class="line"><a id="l00606" name="l00606"></a><span class="lineno">  606</span><span class="comment">   *     to non-blocking op.</span></div>
<div class="line"><a id="l00607" name="l00607"></a><span class="lineno">  607</span><span class="comment">   *   - Timeout, if provided in wait_until, means we start a timer race against the async_wait(); if that</span></div>
<div class="line"><a id="l00608" name="l00608"></a><span class="lineno">  608</span><span class="comment">   *     wins, then stop the async_wait() and on_result() indicating timeout occurred (would-block result).</span></div>
<div class="line"><a id="l00609" name="l00609"></a><span class="lineno">  609</span><span class="comment">   *     It it loses, that timer is canceled at time of loss (async_wait() handler executing). */</span></div>
<div class="line"><a id="l00610" name="l00610"></a><span class="lineno">  610</span> </div>
<div class="line"><a id="l00611" name="l00611"></a><span class="lineno">  611</span>  <span class="comment">/* Unlike for sync_op() (as of this writing), API contract demands Node exist through all of the potential</span></div>
<div class="line"><a id="l00612" name="l00612"></a><span class="lineno">  612</span><span class="comment">   * background wait.  Thus, `this` Node will continue existing throughout, and we can (for example) log without</span></div>
<div class="line"><a id="l00613" name="l00613"></a><span class="lineno">  613</span><span class="comment">   * fear even after the wait finishes.  There is a @todo in class header for making it more like sync_op() in</span></div>
<div class="line"><a id="l00614" name="l00614"></a><span class="lineno">  614</span><span class="comment">   * this sense, but so far it hasn&#39;t seemed important enough to worry about it, consistency being the main</span></div>
<div class="line"><a id="l00615" name="l00615"></a><span class="lineno">  615</span><span class="comment">   * reason to do it.</span></div>
<div class="line"><a id="l00616" name="l00616"></a><span class="lineno">  616</span><span class="comment">   *</span></div>
<div class="line"><a id="l00617" name="l00617"></a><span class="lineno">  617</span><span class="comment">   * Unlike in sync_op(), nothing is locked currently.  So sock could become CLOSED between lines executing</span></div>
<div class="line"><a id="l00618" name="l00618"></a><span class="lineno">  618</span><span class="comment">   * below.  Remember that in below processing. */</span></div>
<div class="line"><a id="l00619" name="l00619"></a><span class="lineno">  619</span> </div>
<div class="line"><a id="l00620" name="l00620"></a><span class="lineno">  620</span>  <a class="code hl_typedef" href="namespaceflow_1_1util.html#ac3e89a8a271b0ddc76ac2a0ce488dea4">util::Task_engine</a>&amp; task_engine = *(sock-&gt;async_task_engine());</div>
<div class="line"><a id="l00621" name="l00621"></a><span class="lineno">  621</span> </div>
<div class="line"><a id="l00622" name="l00622"></a><span class="lineno">  622</span>  <span class="comment">// First create Event_set that&#39;ll await our one socket+status of interest.</span></div>
<div class="line"><a id="l00623" name="l00623"></a><span class="lineno">  623</span> </div>
<div class="line"><a id="l00624" name="l00624"></a><span class="lineno">  624</span>  <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a> err_code;</div>
<div class="line"><a id="l00625" name="l00625"></a><span class="lineno">  625</span>  <span class="keyword">const</span> <a class="code hl_typedef" href="classflow_1_1util_1_1Shared__ptr__alias__holder.html#aa4f1af88393042e60159a3a67f0accbc">Event_set::Ptr</a> event_set = <a class="code hl_function" href="classflow_1_1net__flow_1_1Node.html#ad100464cf0126dbbad39bde1c90a774f">event_set_create</a>(&amp;err_code);</div>
<div class="line"><a id="l00626" name="l00626"></a><span class="lineno">  626</span>  <span class="keywordflow">if</span> (!event_set)</div>
<div class="line"><a id="l00627" name="l00627"></a><span class="lineno">  627</span>  {</div>
<div class="line"><a id="l00628" name="l00628"></a><span class="lineno">  628</span>    on_result(err_code, would_block_ret_val); <span class="comment">// It post()s user&#39;s originally-passed-in handler.</span></div>
<div class="line"><a id="l00629" name="l00629"></a><span class="lineno">  629</span>    <span class="comment">// E.g., err_code might indicate Node is not running().</span></div>
<div class="line"><a id="l00630" name="l00630"></a><span class="lineno">  630</span>    <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00631" name="l00631"></a><span class="lineno">  631</span>  }</div>
<div class="line"><a id="l00632" name="l00632"></a><span class="lineno">  632</span>  <span class="comment">// else event_set ready.  In particular this means running() is true (it cannot become false up to ~Node()).</span></div>
<div class="line"><a id="l00633" name="l00633"></a><span class="lineno">  633</span> </div>
<div class="line"><a id="l00634" name="l00634"></a><span class="lineno">  634</span>  <a class="code hl_define" href="log_8hpp.html#affcf2e4c496ce3f42adf981669c623b8">FLOW_LOG_TRACE</a>(<span class="stringliteral">&quot;Begin async op (identified by Event_set [&quot;</span> &lt;&lt; event_set &lt;&lt; <span class="stringliteral">&quot;]) of type [&quot;</span> &lt;&lt; ev_type &lt;&lt; <span class="stringliteral">&quot;] on &quot;</span></div>
<div class="line"><a id="l00635" name="l00635"></a><span class="lineno">  635</span>                 <span class="stringliteral">&quot;object [&quot;</span> &lt;&lt; sock &lt;&lt; <span class="stringliteral">&quot;].&quot;</span>);</div>
<div class="line"><a id="l00636" name="l00636"></a><span class="lineno">  636</span> </div>
<div class="line"><a id="l00637" name="l00637"></a><span class="lineno">  637</span>  <span class="comment">// Caution: remember event_set must be destroyed when async_op() finishes, synchronously or asynchronously.</span></div>
<div class="line"><a id="l00638" name="l00638"></a><span class="lineno">  638</span> </div>
<div class="line"><a id="l00639" name="l00639"></a><span class="lineno">  639</span>  <span class="comment">// We care about just this event of type ev_type on this socket.  Upcast is required for our use of boost::any().</span></div>
<div class="line"><a id="l00640" name="l00640"></a><span class="lineno">  640</span>  <span class="keywordflow">if</span> (!(event_set-&gt;add_wanted_socket&lt;Base_socket&gt;(Base_socket::ptr_cast(sock), ev_type, &amp;err_code)))</div>
<div class="line"><a id="l00641" name="l00641"></a><span class="lineno">  641</span>  {</div>
<div class="line"><a id="l00642" name="l00642"></a><span class="lineno">  642</span>    on_result(err_code, would_block_ret_val); <span class="comment">// It post()s user&#39;s originally-passed-in handler.</span></div>
<div class="line"><a id="l00643" name="l00643"></a><span class="lineno">  643</span>    <span class="comment">// Node must have shut down or something.  Pretty weird.  Code already logged.</span></div>
<div class="line"><a id="l00644" name="l00644"></a><span class="lineno">  644</span>    <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00645" name="l00645"></a><span class="lineno">  645</span>  }</div>
<div class="line"><a id="l00646" name="l00646"></a><span class="lineno">  646</span>  <span class="comment">// else go ahead and asynchronously wait.</span></div>
<div class="line"><a id="l00647" name="l00647"></a><span class="lineno">  647</span> </div>
<div class="line"><a id="l00648" name="l00648"></a><span class="lineno">  648</span>  <span class="comment">/* Timeout might be finite or infinite (non-existent).  Latter case is much simpler, but for brevity we mix the code</span></div>
<div class="line"><a id="l00649" name="l00649"></a><span class="lineno">  649</span><span class="comment">   * paths of the two cases. */</span></div>
<div class="line"><a id="l00650" name="l00650"></a><span class="lineno">  650</span>  <span class="keyword">const</span> <span class="keywordtype">bool</span> timeout_given = wait_until != <a class="code hl_typedef" href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">Fine_time_pt</a>();</div>
<div class="line"><a id="l00651" name="l00651"></a><span class="lineno">  651</span> </div>
<div class="line"><a id="l00652" name="l00652"></a><span class="lineno">  652</span>  <span class="comment">/* Explanation of why Strand is used / locking discussion:</span></div>
<div class="line"><a id="l00653" name="l00653"></a><span class="lineno">  653</span><span class="comment">   *</span></div>
<div class="line"><a id="l00654" name="l00654"></a><span class="lineno">  654</span><span class="comment">   * In the timeout case, we will be racing between a timer and the async_wait().  Their respective callbacks need</span></div>
<div class="line"><a id="l00655" name="l00655"></a><span class="lineno">  655</span><span class="comment">   * to go on some Task_engine.  The 2 services around are superclass Node&#39;s thread W event loop;</span></div>
<div class="line"><a id="l00656" name="l00656"></a><span class="lineno">  656</span><span class="comment">   * and the user-provided one task_engine.  Thread W is not suitable for 2 reasons: (1) in terms of clean design,</span></div>
<div class="line"><a id="l00657" name="l00657"></a><span class="lineno">  657</span><span class="comment">   * it&#39;s dirty, as we&#39;d be getting into the superclass&#39;s dirty laundry -- asio::Node should be a clean addendum</span></div>
<div class="line"><a id="l00658" name="l00658"></a><span class="lineno">  658</span><span class="comment">   * to net_flow::node, for basic OOP hygiene; (2) thread W is not allowed to make external net_flow API calls itself;</span></div>
<div class="line"><a id="l00659" name="l00659"></a><span class="lineno">  659</span><span class="comment">   * most code assumes thread U != W.  So that leaves user-provided task_engine.  Using it is ideal, because</span></div>
<div class="line"><a id="l00660" name="l00660"></a><span class="lineno">  660</span><span class="comment">   * typically our internally placed handler will soon execute on_handler(), which we advertised is post()ed on</span></div>
<div class="line"><a id="l00661" name="l00661"></a><span class="lineno">  661</span><span class="comment">   * task_engine.  Only one subtle caveat is introduced: conceptually one handler must win the race against the</span></div>
<div class="line"><a id="l00662" name="l00662"></a><span class="lineno">  662</span><span class="comment">   * other, meaning execute serially before it -- for synchronization.  But post()ed handlers are only guaranteed</span></div>
<div class="line"><a id="l00663" name="l00663"></a><span class="lineno">  663</span><span class="comment">   * to execute serially if the Task_engine is run()ning in one thread: user is allowed by boost.asio to run it from 2+</span></div>
<div class="line"><a id="l00664" name="l00664"></a><span class="lineno">  664</span><span class="comment">   * (distributing tasks across threads).  We have 2 choices to deal make them serial anyway: use explicit</span></div>
<div class="line"><a id="l00665" name="l00665"></a><span class="lineno">  665</span><span class="comment">   * synchronization, or use Strand to have Task_engine guarantee they can only run serially (choosing</span></div>
<div class="line"><a id="l00666" name="l00666"></a><span class="lineno">  666</span><span class="comment">   * thread accordingly if applicable -- probably internally by using a mutex anyway).  I use strand for a few reasons.</span></div>
<div class="line"><a id="l00667" name="l00667"></a><span class="lineno">  667</span><span class="comment">   * One, it&#39;s a bit easier to use-or-not-use a strand depending on a Boolean, as opposed to use-or-not-use a mutex;</span></div>
<div class="line"><a id="l00668" name="l00668"></a><span class="lineno">  668</span><span class="comment">   * in particular conditionally creating or not creating a strand seems a bit prettier than same with a mutex.</span></div>
<div class="line"><a id="l00669" name="l00669"></a><span class="lineno">  669</span><span class="comment">   * Two, conceivably the strand mechanism will allow Task_engine to use a thread normally blocked by a mutex lock wait</span></div>
<div class="line"><a id="l00670" name="l00670"></a><span class="lineno">  670</span><span class="comment">   * for something else, maybe another unrelated task might run instead.</span></div>
<div class="line"><a id="l00671" name="l00671"></a><span class="lineno">  671</span><span class="comment">   *</span></div>
<div class="line"><a id="l00672" name="l00672"></a><span class="lineno">  672</span><span class="comment">   * There is one more synchronization challenge.  2+ async_*() ops can run simultaneously on one socket object.</span></div>
<div class="line"><a id="l00673" name="l00673"></a><span class="lineno">  673</span><span class="comment">   * We access no shared data in such a case except for the short moment when we actually run the non-blocking op, when</span></div>
<div class="line"><a id="l00674" name="l00674"></a><span class="lineno">  674</span><span class="comment">   * events are ready simultanously for the 2+ async ops.  No mutex is needed, however, because net_flow::*_socket</span></div>
<div class="line"><a id="l00675" name="l00675"></a><span class="lineno">  675</span><span class="comment">   * are advertised as thread-safe for simultaneous method calls on one object. */</span></div>
<div class="line"><a id="l00676" name="l00676"></a><span class="lineno">  676</span>  <span class="keyword">using </span><a class="code hl_typedef" href="namespaceflow_1_1util.html#aa59354ab408e978c8a7bda1a4706924e">Strand</a> = <a class="code hl_typedef" href="namespaceflow_1_1util.html#aa59354ab408e978c8a7bda1a4706924e">util::Strand</a>;</div>
<div class="line"><a id="l00677" name="l00677"></a><span class="lineno">  677</span> </div>
<div class="line"><a id="l00678" name="l00678"></a><span class="lineno">  678</span>  <span class="comment">// This stuff is unused if !timeout_given.</span></div>
<div class="line"><a id="l00679" name="l00679"></a><span class="lineno">  679</span>  <span class="keyword">struct </span>Timeout_state <span class="comment">// Collection of state allocated on heap until the (subject-to-timeout) op completes.</span></div>
<div class="line"><a id="l00680" name="l00680"></a><span class="lineno">  680</span>  {</div>
<div class="line"><a id="l00681" name="l00681"></a><span class="lineno">  681</span>    <a class="code hl_typedef" href="namespaceflow_1_1util.html#aa0d10f5a906b3229f48979aa43e9ff7e">util::Scheduled_task_handle</a> sched_task;</div>
<div class="line"><a id="l00682" name="l00682"></a><span class="lineno">  682</span>    <a class="code hl_typedef" href="namespaceflow_1_1util.html#aa59354ab408e978c8a7bda1a4706924e">Strand</a> m_make_serial;</div>
<div class="line"><a id="l00683" name="l00683"></a><span class="lineno">  683</span>    Timeout_state(<a class="code hl_typedef" href="namespaceflow_1_1util.html#ac3e89a8a271b0ddc76ac2a0ce488dea4">util::Task_engine</a>&amp; svc) : m_make_serial(svc) {}</div>
<div class="line"><a id="l00684" name="l00684"></a><span class="lineno">  684</span>  };</div>
<div class="line"><a id="l00685" name="l00685"></a><span class="lineno">  685</span>  <span class="keyword">using </span>Timeout_state_ptr = shared_ptr&lt;Timeout_state&gt;; <span class="comment">// Use a ref-counted pointer to ensure it&#39;s around until done.</span></div>
<div class="line"><a id="l00686" name="l00686"></a><span class="lineno">  686</span>  Timeout_state_ptr timeout_state;</div>
<div class="line"><a id="l00687" name="l00687"></a><span class="lineno">  687</span> </div>
<div class="line"><a id="l00688" name="l00688"></a><span class="lineno">  688</span>  <span class="keywordflow">if</span> (timeout_given)</div>
<div class="line"><a id="l00689" name="l00689"></a><span class="lineno">  689</span>  {</div>
<div class="line"><a id="l00690" name="l00690"></a><span class="lineno">  690</span>    <span class="keywordflow">if</span> (wait_until &lt;= Fine_clock::now()) <span class="comment">// A little optimization of a corner case; why not?</span></div>
<div class="line"><a id="l00691" name="l00691"></a><span class="lineno">  691</span>    {</div>
<div class="line"><a id="l00692" name="l00692"></a><span class="lineno">  692</span>      on_result(<a class="code hl_enumvalue" href="namespaceflow_1_1net__flow_1_1error.html#a18e13de77b119ea0f2be411490859482ab835895723a7d71c964b84e0f0b78c3c">error::Code::S_WAIT_USER_TIMEOUT</a>, would_block_ret_val); <span class="comment">// post()s user&#39;s originally-passed-in handler.</span></div>
<div class="line"><a id="l00693" name="l00693"></a><span class="lineno">  693</span>      <span class="comment">// Same as if wait actually occurred and timed out.</span></div>
<div class="line"><a id="l00694" name="l00694"></a><span class="lineno">  694</span>      <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00695" name="l00695"></a><span class="lineno">  695</span>    }</div>
<div class="line"><a id="l00696" name="l00696"></a><span class="lineno">  696</span>    <span class="comment">// else</span></div>
<div class="line"><a id="l00697" name="l00697"></a><span class="lineno">  697</span> </div>
<div class="line"><a id="l00698" name="l00698"></a><span class="lineno">  698</span>    <a class="code hl_define" href="log_8hpp.html#affcf2e4c496ce3f42adf981669c623b8">FLOW_LOG_TRACE</a>(<span class="stringliteral">&quot;Timeout timer begin for async op [&quot;</span> &lt;&lt; event_set &lt;&lt; <span class="stringliteral">&quot;] in &quot;</span></div>
<div class="line"><a id="l00699" name="l00699"></a><span class="lineno">  699</span>                   <span class="stringliteral">&quot;period [&quot;</span> &lt;&lt; round&lt;milliseconds&gt;(wait_until - Fine_clock::now()) &lt;&lt; <span class="stringliteral">&quot;].&quot;</span>);</div>
<div class="line"><a id="l00700" name="l00700"></a><span class="lineno">  700</span> </div>
<div class="line"><a id="l00701" name="l00701"></a><span class="lineno">  701</span>    <span class="comment">// Start one of the racers: the timer that&#39;ll fire once timeout is finished.</span></div>
<div class="line"><a id="l00702" name="l00702"></a><span class="lineno">  702</span> </div>
<div class="line"><a id="l00703" name="l00703"></a><span class="lineno">  703</span>    <span class="comment">// All the stuff needed by timeout can now be created (if !timeout_given, we save resources by not doing this).</span></div>
<div class="line"><a id="l00704" name="l00704"></a><span class="lineno">  704</span>    timeout_state.reset(<span class="keyword">new</span> Timeout_state(task_engine));</div>
<div class="line"><a id="l00705" name="l00705"></a><span class="lineno">  705</span> </div>
<div class="line"><a id="l00706" name="l00706"></a><span class="lineno">  706</span>    <span class="comment">// Performance note: cannot move(on_result) here, as we still need on_result for 2nd closure made below.  Copy.</span></div>
<div class="line"><a id="l00707" name="l00707"></a><span class="lineno">  707</span>    timeout_state-&gt;sched_task</div>
<div class="line"><a id="l00708" name="l00708"></a><span class="lineno">  708</span>      = <a class="code hl_function" href="namespaceflow_1_1util.html#aad8c8f7335eb892350dc386cb4be397e">util::schedule_task_at</a>(<a class="code hl_function" href="classflow_1_1log_1_1Log__context.html#af4db395042b065b00398cd59845dcb4d">get_logger</a>(), wait_until,</div>
<div class="line"><a id="l00709" name="l00709"></a><span class="lineno">  709</span>                               <span class="keyword">true</span>, <span class="comment">// Single-threaded!</span></div>
<div class="line"><a id="l00710" name="l00710"></a><span class="lineno">  710</span>                               &amp;task_engine,</div>
<div class="line"><a id="l00711" name="l00711"></a><span class="lineno">  711</span>                               bind_executor(timeout_state-&gt;m_make_serial,</div>
<div class="line"><a id="l00712" name="l00712"></a><span class="lineno">  712</span>                                             [<span class="keyword">this</span>, timeout_state, on_result, would_block_ret_val, event_set]</div>
<div class="line"><a id="l00713" name="l00713"></a><span class="lineno">  713</span>                                               (<span class="keywordtype">bool</span>)</div>
<div class="line"><a id="l00714" name="l00714"></a><span class="lineno">  714</span>    {</div>
<div class="line"><a id="l00715" name="l00715"></a><span class="lineno">  715</span>      <span class="comment">// We are in thread V != W.  V may or may not be U.  V is any thread where user&#39;s Task_engine is run()ning.</span></div>
<div class="line"><a id="l00716" name="l00716"></a><span class="lineno">  716</span> </div>
<div class="line"><a id="l00717" name="l00717"></a><span class="lineno">  717</span>      FLOW_LOG_TRACE(<span class="stringliteral">&quot;[User event loop] &quot;</span></div>
<div class="line"><a id="l00718" name="l00718"></a><span class="lineno">  718</span>                     <span class="stringliteral">&quot;Timeout fired for async op [&quot;</span> &lt;&lt; event_set &lt;&lt; <span class="stringliteral">&quot;]; clean up and report to user.&quot;</span>);</div>
<div class="line"><a id="l00719" name="l00719"></a><span class="lineno">  719</span> </div>
<div class="line"><a id="l00720" name="l00720"></a><span class="lineno">  720</span>      Error_code dummy_prevents_throw;</div>
<div class="line"><a id="l00721" name="l00721"></a><span class="lineno">  721</span>      event_set-&gt;async_wait_finish(&amp;dummy_prevents_throw);</div>
<div class="line"><a id="l00722" name="l00722"></a><span class="lineno">  722</span>      event_set-&gt;close(&amp;dummy_prevents_throw);</div>
<div class="line"><a id="l00723" name="l00723"></a><span class="lineno">  723</span> </div>
<div class="line"><a id="l00724" name="l00724"></a><span class="lineno">  724</span>      FLOW_LOG_TRACE(<span class="stringliteral">&quot;[User event loop] User handler execution begins for async op [&quot;</span> &lt;&lt; event_set &lt;&lt; <span class="stringliteral">&quot;].&quot;</span>);</div>
<div class="line"><a id="l00725" name="l00725"></a><span class="lineno">  725</span>      on_result(error::Code::S_WAIT_USER_TIMEOUT, would_block_ret_val); <span class="comment">// post()s user&#39;s originally-passed-in handler.</span></div>
<div class="line"><a id="l00726" name="l00726"></a><span class="lineno">  726</span> </div>
<div class="line"><a id="l00727" name="l00727"></a><span class="lineno">  727</span>      FLOW_LOG_TRACE(<span class="stringliteral">&quot;[User event loop] User handler execution ends for async op [&quot;</span> &lt;&lt; event_set &lt;&lt; <span class="stringliteral">&quot;].&quot;</span>);</div>
<div class="line"><a id="l00728" name="l00728"></a><span class="lineno">  728</span>    })); <span class="comment">// timer.async_wait() callback.</span></div>
<div class="line"><a id="l00729" name="l00729"></a><span class="lineno">  729</span>  } <span class="comment">// if (timeout_given)</span></div>
<div class="line"><a id="l00730" name="l00730"></a><span class="lineno">  730</span> </div>
<div class="line"><a id="l00731" name="l00731"></a><span class="lineno">  731</span>  <span class="comment">// If there&#39;s a timeout, timer started for it.  Now prepare the mandatory Event_set::async_wait() for readiness.</span></div>
<div class="line"><a id="l00732" name="l00732"></a><span class="lineno">  732</span> </div>
<div class="line"><a id="l00733" name="l00733"></a><span class="lineno">  733</span>  <span class="comment">/* This will run as post()ed task on user&#39;s given target Task_engine.</span></div>
<div class="line"><a id="l00734" name="l00734"></a><span class="lineno">  734</span><span class="comment">   * Caution!  non_blocking_func is potentially destroyed (by move()) by the following assignment.</span></div>
<div class="line"><a id="l00735" name="l00735"></a><span class="lineno">  735</span><span class="comment">   * Caution!  Same with on_result.  We don&#39;t need on_result for any more closures below, so this is OK. */</span></div>
<div class="line"><a id="l00736" name="l00736"></a><span class="lineno">  736</span>  <span class="keyword">auto</span> on_async_wait_user_loop</div>
<div class="line"><a id="l00737" name="l00737"></a><span class="lineno">  737</span>    = [<span class="keyword">this</span>, sock, timeout_state, would_block_ret_val, ev_type, wait_until, event_set,</div>
<div class="line"><a id="l00738" name="l00738"></a><span class="lineno">  738</span>       non_blocking_func = std::move(non_blocking_func),</div>
<div class="line"><a id="l00739" name="l00739"></a><span class="lineno">  739</span>       on_result = std::move(on_result)]</div>
<div class="line"><a id="l00740" name="l00740"></a><span class="lineno">  740</span>        (<span class="keywordtype">bool</span> interrupted)</div>
<div class="line"><a id="l00741" name="l00741"></a><span class="lineno">  741</span>        <span class="comment">/* The two Function&lt;&gt;s may be move()d themselves inside, so those closure type members cannot be const.</span></div>
<div class="line"><a id="l00742" name="l00742"></a><span class="lineno">  742</span><span class="comment">         * Caution!  This pattern also makes on_async_wait_user_loop() a one-time-use closure. */</span></div>
<div class="line"><a id="l00743" name="l00743"></a><span class="lineno">  743</span>        <span class="keyword">mutable</span></div>
<div class="line"><a id="l00744" name="l00744"></a><span class="lineno">  744</span>  {</div>
<div class="line"><a id="l00745" name="l00745"></a><span class="lineno">  745</span>    <span class="comment">// We are in thread V != W.  V may or may not be U.  V is any thread where user&#39;s Task_engine is run()ning.</span></div>
<div class="line"><a id="l00746" name="l00746"></a><span class="lineno">  746</span> </div>
<div class="line"><a id="l00747" name="l00747"></a><span class="lineno">  747</span>    <span class="comment">// Only watching for one event, so either interrupted is true, or the event is active.  Can thus clean this now.</span></div>
<div class="line"><a id="l00748" name="l00748"></a><span class="lineno">  748</span>    <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a> dummy_prevents_throw;</div>
<div class="line"><a id="l00749" name="l00749"></a><span class="lineno">  749</span>    event_set-&gt;close(&amp;dummy_prevents_throw);</div>
<div class="line"><a id="l00750" name="l00750"></a><span class="lineno">  750</span> </div>
<div class="line"><a id="l00751" name="l00751"></a><span class="lineno">  751</span>    <span class="keywordflow">if</span> (timeout_state</div>
<div class="line"><a id="l00752" name="l00752"></a><span class="lineno">  752</span>        &amp;&amp;</div>
<div class="line"><a id="l00753" name="l00753"></a><span class="lineno">  753</span>        <span class="comment">// We were racing timeout timer, and we may have won.  Check if indeed we won.</span></div>
<div class="line"><a id="l00754" name="l00754"></a><span class="lineno">  754</span>        (!<a class="code hl_function" href="namespaceflow_1_1util.html#ad92e68a1b22556f2625292098c0036a2">util::scheduled_task_cancel</a>(<a class="code hl_function" href="classflow_1_1log_1_1Log__context.html#af4db395042b065b00398cd59845dcb4d">get_logger</a>(), timeout_state-&gt;sched_task)))</div>
<div class="line"><a id="l00755" name="l00755"></a><span class="lineno">  755</span>    {</div>
<div class="line"><a id="l00756" name="l00756"></a><span class="lineno">  756</span>      <span class="comment">/* Couldn&#39;t cancel it, so it *will* have run very soon.  We lost.</span></div>
<div class="line"><a id="l00757" name="l00757"></a><span class="lineno">  757</span><span class="comment">       * I didn&#39;t burrow in hard to see if this is really possible, but conceptually why not?  Be ready for it. */</span></div>
<div class="line"><a id="l00758" name="l00758"></a><span class="lineno">  758</span>      <a class="code hl_define" href="log_8hpp.html#a325fdd4b5cf0be49b37d3b7b7c29070d">FLOW_LOG_INFO</a>(<span class="stringliteral">&quot;[User event loop] &quot;</span></div>
<div class="line"><a id="l00759" name="l00759"></a><span class="lineno">  759</span>                    <span class="stringliteral">&quot;Events-ready in async op [&quot;</span> &lt;&lt; event_set &lt;&lt; <span class="stringliteral">&quot;], but timeout already expired recently.  &quot;</span></div>
<div class="line"><a id="l00760" name="l00760"></a><span class="lineno">  760</span>                    <span class="stringliteral">&quot;Interesting timing coincidence.&quot;</span>);</div>
<div class="line"><a id="l00761" name="l00761"></a><span class="lineno">  761</span>      <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00762" name="l00762"></a><span class="lineno">  762</span>    }</div>
<div class="line"><a id="l00763" name="l00763"></a><span class="lineno">  763</span>    <span class="comment">// else</span></div>
<div class="line"><a id="l00764" name="l00764"></a><span class="lineno">  764</span> </div>
<div class="line"><a id="l00765" name="l00765"></a><span class="lineno">  765</span>    <span class="comment">// There is no timeout, or there is but has not expired before us.  Is socket active, or were we interrupted?</span></div>
<div class="line"><a id="l00766" name="l00766"></a><span class="lineno">  766</span> </div>
<div class="line"><a id="l00767" name="l00767"></a><span class="lineno">  767</span>    <span class="keywordflow">if</span> (interrupted)</div>
<div class="line"><a id="l00768" name="l00768"></a><span class="lineno">  768</span>    {</div>
<div class="line"><a id="l00769" name="l00769"></a><span class="lineno">  769</span>      <span class="comment">// Conceptually like EINTR.  Log and done.</span></div>
<div class="line"><a id="l00770" name="l00770"></a><span class="lineno">  770</span>      <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a> err_code_val;</div>
<div class="line"><a id="l00771" name="l00771"></a><span class="lineno">  771</span>      <span class="keyword">const</span> <span class="keyword">auto</span> err_code = &amp;err_code_val;</div>
<div class="line"><a id="l00772" name="l00772"></a><span class="lineno">  772</span>      <a class="code hl_define" href="error_2error_8hpp.html#ab6b8ed79012c994cfc381e0b92c066fd">FLOW_ERROR_EMIT_ERROR</a>(<a class="code hl_enumvalue" href="namespaceflow_1_1net__flow_1_1error.html#a18e13de77b119ea0f2be411490859482ab92ec3b2b78d74acf0fda0786f601df5">error::Code::S_WAIT_INTERRUPTED</a>);</div>
<div class="line"><a id="l00773" name="l00773"></a><span class="lineno">  773</span> </div>
<div class="line"><a id="l00774" name="l00774"></a><span class="lineno">  774</span>      <a class="code hl_define" href="log_8hpp.html#affcf2e4c496ce3f42adf981669c623b8">FLOW_LOG_TRACE</a>(<span class="stringliteral">&quot;[User event loop] &quot;</span></div>
<div class="line"><a id="l00775" name="l00775"></a><span class="lineno">  775</span>                     <span class="stringliteral">&quot;Events-ready in async op [&quot;</span> &lt;&lt; event_set &lt;&lt; <span class="stringliteral">&quot;]; user handler execution begins.&quot;</span>);</div>
<div class="line"><a id="l00776" name="l00776"></a><span class="lineno">  776</span>      on_result(err_code_val, would_block_ret_val); <span class="comment">// It post()s user&#39;s originally-passed-in handler.</span></div>
<div class="line"><a id="l00777" name="l00777"></a><span class="lineno">  777</span>    }</div>
<div class="line"><a id="l00778" name="l00778"></a><span class="lineno">  778</span>    <span class="keywordflow">else</span></div>
<div class="line"><a id="l00779" name="l00779"></a><span class="lineno">  779</span>    {</div>
<div class="line"><a id="l00780" name="l00780"></a><span class="lineno">  780</span>      assert(!interrupted);</div>
<div class="line"><a id="l00781" name="l00781"></a><span class="lineno">  781</span> </div>
<div class="line"><a id="l00782" name="l00782"></a><span class="lineno">  782</span>      <span class="comment">/* OK.  async_wait() reports event is ready (sock is active, e.g., Writable).  Try to perform</span></div>
<div class="line"><a id="l00783" name="l00783"></a><span class="lineno">  783</span><span class="comment">       * non-blocking operation (e.g., Peer_socket::send()).  Another async_op() may asynchronously run a</span></div>
<div class="line"><a id="l00784" name="l00784"></a><span class="lineno">  784</span><span class="comment">       * non-blocking op at the same time from different thread, but no mutex needed as explained in long-ish</span></div>
<div class="line"><a id="l00785" name="l00785"></a><span class="lineno">  785</span><span class="comment">       * comment above. */</span></div>
<div class="line"><a id="l00786" name="l00786"></a><span class="lineno">  786</span> </div>
<div class="line"><a id="l00787" name="l00787"></a><span class="lineno">  787</span>      Non_blocking_func_ret_type op_result;</div>
<div class="line"><a id="l00788" name="l00788"></a><span class="lineno">  788</span>      <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a> op_err_code;</div>
<div class="line"><a id="l00789" name="l00789"></a><span class="lineno">  789</span>      <span class="keyword">const</span> <span class="keywordtype">bool</span> reactor_pattern = non_blocking_func.empty(); <span class="comment">// How this mode is indicated.</span></div>
<div class="line"><a id="l00790" name="l00790"></a><span class="lineno">  790</span> </div>
<div class="line"><a id="l00791" name="l00791"></a><span class="lineno">  791</span>      <span class="keywordflow">if</span> (reactor_pattern)</div>
<div class="line"><a id="l00792" name="l00792"></a><span class="lineno">  792</span>      {</div>
<div class="line"><a id="l00793" name="l00793"></a><span class="lineno">  793</span>        <span class="comment">// They want to presumably perform the op themselves in handler.  Skip; would-block-no-error as advertised.</span></div>
<div class="line"><a id="l00794" name="l00794"></a><span class="lineno">  794</span>        assert(!op_err_code);</div>
<div class="line"><a id="l00795" name="l00795"></a><span class="lineno">  795</span> </div>
<div class="line"><a id="l00796" name="l00796"></a><span class="lineno">  796</span>        <a class="code hl_define" href="log_8hpp.html#affcf2e4c496ce3f42adf981669c623b8">FLOW_LOG_TRACE</a>(<span class="stringliteral">&quot;[User event loop] &quot;</span></div>
<div class="line"><a id="l00797" name="l00797"></a><span class="lineno">  797</span>                       <span class="stringliteral">&quot;Events-ready in async op [&quot;</span> &lt;&lt; event_set &lt;&lt; <span class="stringliteral">&quot;]; reactor pattern mode on; &quot;</span></div>
<div class="line"><a id="l00798" name="l00798"></a><span class="lineno">  798</span>                       <span class="stringliteral">&quot;user handler execution begins.&quot;</span>);</div>
<div class="line"><a id="l00799" name="l00799"></a><span class="lineno">  799</span>        on_result(op_err_code, would_block_ret_val); <span class="comment">// It post()s user&#39;s originally-passed-in handler.</span></div>
<div class="line"><a id="l00800" name="l00800"></a><span class="lineno">  800</span>      }</div>
<div class="line"><a id="l00801" name="l00801"></a><span class="lineno">  801</span>      <span class="keywordflow">else</span></div>
<div class="line"><a id="l00802" name="l00802"></a><span class="lineno">  802</span>      {</div>
<div class="line"><a id="l00803" name="l00803"></a><span class="lineno">  803</span>        assert(!reactor_pattern);</div>
<div class="line"><a id="l00804" name="l00804"></a><span class="lineno">  804</span> </div>
<div class="line"><a id="l00805" name="l00805"></a><span class="lineno">  805</span>        <a class="code hl_define" href="log_8hpp.html#affcf2e4c496ce3f42adf981669c623b8">FLOW_LOG_TRACE</a>(<span class="stringliteral">&quot;[User event loop] &quot;</span></div>
<div class="line"><a id="l00806" name="l00806"></a><span class="lineno">  806</span>                       <span class="stringliteral">&quot;Events-ready in async op [&quot;</span> &lt;&lt; event_set &lt;&lt; <span class="stringliteral">&quot;]; reactor pattern mode off; &quot;</span></div>
<div class="line"><a id="l00807" name="l00807"></a><span class="lineno">  807</span>                       <span class="stringliteral">&quot;executing non-blocking operation now.&quot;</span>);</div>
<div class="line"><a id="l00808" name="l00808"></a><span class="lineno">  808</span>        op_result = non_blocking_func(&amp;op_err_code); <span class="comment">// send(), receive(), accept(), etc.</span></div>
<div class="line"><a id="l00809" name="l00809"></a><span class="lineno">  809</span> </div>
<div class="line"><a id="l00810" name="l00810"></a><span class="lineno">  810</span>        <span class="keywordflow">if</span> (op_err_code)</div>
<div class="line"><a id="l00811" name="l00811"></a><span class="lineno">  811</span>        {</div>
<div class="line"><a id="l00812" name="l00812"></a><span class="lineno">  812</span>          <span class="comment">// Any number of errors possible here; error on socket =&gt; socket is active.</span></div>
<div class="line"><a id="l00813" name="l00813"></a><span class="lineno">  813</span> </div>
<div class="line"><a id="l00814" name="l00814"></a><span class="lineno">  814</span>          <a class="code hl_define" href="log_8hpp.html#affcf2e4c496ce3f42adf981669c623b8">FLOW_LOG_TRACE</a>(<span class="stringliteral">&quot;[User event loop] &quot;</span></div>
<div class="line"><a id="l00815" name="l00815"></a><span class="lineno">  815</span>                         <span class="stringliteral">&quot;Error observed in instant op; code [&quot;</span> &lt;&lt; op_err_code &lt;&lt; <span class="charliteral">&#39;/&#39;</span> &lt;&lt; op_err_code.message() &lt;&lt; <span class="stringliteral">&quot;]; &quot;</span></div>
<div class="line"><a id="l00816" name="l00816"></a><span class="lineno">  816</span>                         <span class="stringliteral">&quot;in async op [&quot;</span> &lt;&lt; event_set &lt;&lt; <span class="stringliteral">&quot;]; &quot;</span></div>
<div class="line"><a id="l00817" name="l00817"></a><span class="lineno">  817</span>                         <span class="stringliteral">&quot;user handler execution begins.&quot;</span>);</div>
<div class="line"><a id="l00818" name="l00818"></a><span class="lineno">  818</span>          on_result(op_err_code, would_block_ret_val); <span class="comment">// It post()s user&#39;s originally-passed-in handler.</span></div>
<div class="line"><a id="l00819" name="l00819"></a><span class="lineno">  819</span>        }</div>
<div class="line"><a id="l00820" name="l00820"></a><span class="lineno">  820</span>        <span class="keywordflow">else</span></div>
<div class="line"><a id="l00821" name="l00821"></a><span class="lineno">  821</span>        {</div>
<div class="line"><a id="l00822" name="l00822"></a><span class="lineno">  822</span>          assert(!op_err_code);</div>
<div class="line"><a id="l00823" name="l00823"></a><span class="lineno">  823</span>          <span class="comment">// No error, but did we get a result, or is it would-block?</span></div>
<div class="line"><a id="l00824" name="l00824"></a><span class="lineno">  824</span> </div>
<div class="line"><a id="l00825" name="l00825"></a><span class="lineno">  825</span>          <span class="keywordflow">if</span> (op_result == would_block_ret_val)</div>
<div class="line"><a id="l00826" name="l00826"></a><span class="lineno">  826</span>          {</div>
<div class="line"><a id="l00827" name="l00827"></a><span class="lineno">  827</span>            <a class="code hl_define" href="log_8hpp.html#affcf2e4c496ce3f42adf981669c623b8">FLOW_LOG_TRACE</a>(<span class="stringliteral">&quot;[User event loop] &quot;</span></div>
<div class="line"><a id="l00828" name="l00828"></a><span class="lineno">  828</span>                           <span class="stringliteral">&quot;Instant op yielded would-block despite events-ready &quot;</span></div>
<div class="line"><a id="l00829" name="l00829"></a><span class="lineno">  829</span>                           <span class="stringliteral">&quot;in async op [&quot;</span> &lt;&lt; event_set &lt;&lt; <span class="stringliteral">&quot;]; are there concurrent competing operations?  &quot;</span></div>
<div class="line"><a id="l00830" name="l00830"></a><span class="lineno">  830</span>                           <span class="stringliteral">&quot;Trying async op again.&quot;</span>);</div>
<div class="line"><a id="l00831" name="l00831"></a><span class="lineno">  831</span>            assert(!reactor_pattern); <span class="comment">// We can&#39;t know whether it worked in reactor_pattern mode.  User finds out.</span></div>
<div class="line"><a id="l00832" name="l00832"></a><span class="lineno">  832</span> </div>
<div class="line"><a id="l00833" name="l00833"></a><span class="lineno">  833</span>            <span class="comment">/* If timeout_given, then effectively this reduces the time left in timeout and tries again</span></div>
<div class="line"><a id="l00834" name="l00834"></a><span class="lineno">  834</span><span class="comment">             * (time has passed; wait_until has remained constant).</span></div>
<div class="line"><a id="l00835" name="l00835"></a><span class="lineno">  835</span><span class="comment">             * If !timeout_given, then this will just keep trying forever, until the jerk in another thread, or</span></div>
<div class="line"><a id="l00836" name="l00836"></a><span class="lineno">  836</span><span class="comment">             * wherever, taking our stuff even when we get active events, stops jerking us around. */</span></div>
<div class="line"><a id="l00837" name="l00837"></a><span class="lineno">  837</span>            <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#a0cf22e56b3c091645154719eeb49ff4a">async_op</a></div>
<div class="line"><a id="l00838" name="l00838"></a><span class="lineno">  838</span>              &lt;Socket, Base_socket, Non_blocking_func_ret_type&gt;</div>
<div class="line"><a id="l00839" name="l00839"></a><span class="lineno">  839</span>              (sock, std::move(non_blocking_func),</div>
<div class="line"><a id="l00840" name="l00840"></a><span class="lineno">  840</span>               would_block_ret_val, ev_type, wait_until, std::move(on_result));</div>
<div class="line"><a id="l00841" name="l00841"></a><span class="lineno">  841</span>            <span class="comment">// on_result, non_blocking_func are now potentially destroyed, but we don&#39;t need them anymore:</span></div>
<div class="line"><a id="l00842" name="l00842"></a><span class="lineno">  842</span>            <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00843" name="l00843"></a><span class="lineno">  843</span>          }</div>
<div class="line"><a id="l00844" name="l00844"></a><span class="lineno">  844</span>          <span class="comment">// else got actual result!</span></div>
<div class="line"><a id="l00845" name="l00845"></a><span class="lineno">  845</span> </div>
<div class="line"><a id="l00846" name="l00846"></a><span class="lineno">  846</span>          <a class="code hl_define" href="log_8hpp.html#affcf2e4c496ce3f42adf981669c623b8">FLOW_LOG_TRACE</a>(<span class="stringliteral">&quot;[User event loop] &quot;</span></div>
<div class="line"><a id="l00847" name="l00847"></a><span class="lineno">  847</span>                         <span class="stringliteral">&quot;Instant op yielded positive result [&quot;</span> &lt;&lt; op_result &lt;&lt; <span class="stringliteral">&quot;] &quot;</span></div>
<div class="line"><a id="l00848" name="l00848"></a><span class="lineno">  848</span>                         <span class="stringliteral">&quot;in async op [&quot;</span> &lt;&lt; event_set &lt;&lt; <span class="stringliteral">&quot;]; &quot;</span></div>
<div class="line"><a id="l00849" name="l00849"></a><span class="lineno">  849</span>                         <span class="stringliteral">&quot;user handler execution begins.&quot;</span>);</div>
<div class="line"><a id="l00850" name="l00850"></a><span class="lineno">  850</span> </div>
<div class="line"><a id="l00851" name="l00851"></a><span class="lineno">  851</span>          assert(op_result != would_block_ret_val);</div>
<div class="line"><a id="l00852" name="l00852"></a><span class="lineno">  852</span>          assert(!op_err_code);</div>
<div class="line"><a id="l00853" name="l00853"></a><span class="lineno">  853</span>          on_result(op_err_code, op_result); <span class="comment">// It post()s user&#39;s originally-passed-in handler.</span></div>
<div class="line"><a id="l00854" name="l00854"></a><span class="lineno">  854</span>        } <span class="comment">// else if (!op_err_code)</span></div>
<div class="line"><a id="l00855" name="l00855"></a><span class="lineno">  855</span>      } <span class="comment">// else if (!reactor_pattern)</span></div>
<div class="line"><a id="l00856" name="l00856"></a><span class="lineno">  856</span>    }</div>
<div class="line"><a id="l00857" name="l00857"></a><span class="lineno">  857</span> </div>
<div class="line"><a id="l00858" name="l00858"></a><span class="lineno">  858</span>    <span class="comment">// Note all paths lead here, except the `return;` above for when we try again.</span></div>
<div class="line"><a id="l00859" name="l00859"></a><span class="lineno">  859</span>    <a class="code hl_define" href="log_8hpp.html#affcf2e4c496ce3f42adf981669c623b8">FLOW_LOG_TRACE</a>(<span class="stringliteral">&quot;[User event loop] User handler execution ends for async op [&quot;</span> &lt;&lt; event_set &lt;&lt; <span class="stringliteral">&quot;].&quot;</span>);</div>
<div class="line"><a id="l00860" name="l00860"></a><span class="lineno">  860</span>  }; <span class="comment">//  on_async_wait_user_loop =</span></div>
<div class="line"><a id="l00861" name="l00861"></a><span class="lineno">  861</span> </div>
<div class="line"><a id="l00862" name="l00862"></a><span class="lineno">  862</span>  <span class="comment">/* Now begin the wait for readiness.</span></div>
<div class="line"><a id="l00863" name="l00863"></a><span class="lineno">  863</span><span class="comment">   * Aside: There are strong reasons not to do anything but post(), directly in the thread W-executed handler, and</span></div>
<div class="line"><a id="l00864" name="l00864"></a><span class="lineno">  864</span><span class="comment">   * they are discussed above.  However, in any case, note that async_wait() API doc says handler</span></div>
<div class="line"><a id="l00865" name="l00865"></a><span class="lineno">  865</span><span class="comment">   * must not itself call anything related to the entire Node from which the Event_set comes.</span></div>
<div class="line"><a id="l00866" name="l00866"></a><span class="lineno">  866</span><span class="comment">   * Our choosing to post() elsewhere is a very vanilla thing to do in an async_wait() handler per its docs. */</span></div>
<div class="line"><a id="l00867" name="l00867"></a><span class="lineno">  867</span> </div>
<div class="line"><a id="l00868" name="l00868"></a><span class="lineno">  868</span>  <span class="keywordflow">if</span> (timeout_given)</div>
<div class="line"><a id="l00869" name="l00869"></a><span class="lineno">  869</span>  {</div>
<div class="line"><a id="l00870" name="l00870"></a><span class="lineno">  870</span>    <span class="comment">// As above, `mutable` so that the captured closure can be move()d inside (no more than once ever).</span></div>
<div class="line"><a id="l00871" name="l00871"></a><span class="lineno">  871</span>    event_set-&gt;async_wait([sock, timeout_state,</div>
<div class="line"><a id="l00872" name="l00872"></a><span class="lineno">  872</span>                           on_async_wait_user_loop = std::move(on_async_wait_user_loop)]</div>
<div class="line"><a id="l00873" name="l00873"></a><span class="lineno">  873</span>                          (<span class="keywordtype">bool</span> interrupted) <span class="keyword">mutable</span></div>
<div class="line"><a id="l00874" name="l00874"></a><span class="lineno">  874</span>    {</div>
<div class="line"><a id="l00875" name="l00875"></a><span class="lineno">  875</span>      <span class="comment">/* We are in thread W.  Put the handler into user&#39;s event loop, as discussed, but make it serial with timeout.</span></div>
<div class="line"><a id="l00876" name="l00876"></a><span class="lineno">  876</span><span class="comment">       * Note: if Task_engine E and Strand S(E), then post(E, b_e(S, f)) is an anti-pattern for subtle reasons, though</span></div>
<div class="line"><a id="l00877" name="l00877"></a><span class="lineno">  877</span><span class="comment">       * in our case &quot;tie-breaking&quot; order doesn&#39;t matter, hence at worst it would only be slower.  Still, use the proper</span></div>
<div class="line"><a id="l00878" name="l00878"></a><span class="lineno">  878</span><span class="comment">       * pattern: post(S, f).  Note on note: &lt;some async op on I/O object associated with E&gt;(..., b_e(S, f)) is just</span></div>
<div class="line"><a id="l00879" name="l00879"></a><span class="lineno">  879</span><span class="comment">       * fine and in fact we do that elsewhere in this function. */</span></div>
<div class="line"><a id="l00880" name="l00880"></a><span class="lineno">  880</span>      post(timeout_state-&gt;m_make_serial, [interrupted,</div>
<div class="line"><a id="l00881" name="l00881"></a><span class="lineno">  881</span>                                          on_async_wait_user_loop = std::move(on_async_wait_user_loop)]</div>
<div class="line"><a id="l00882" name="l00882"></a><span class="lineno">  882</span>                                           () <span class="keyword">mutable</span></div>
<div class="line"><a id="l00883" name="l00883"></a><span class="lineno">  883</span>      {</div>
<div class="line"><a id="l00884" name="l00884"></a><span class="lineno">  884</span>        on_async_wait_user_loop(interrupted); <span class="comment">// (This call mutates on_async_wait_user_loop closure *itself*.)</span></div>
<div class="line"><a id="l00885" name="l00885"></a><span class="lineno">  885</span>      });</div>
<div class="line"><a id="l00886" name="l00886"></a><span class="lineno">  886</span>      <span class="comment">// BTW strand docs say strand need only exist through the post() call itself.  So this async path is done w/ it.</span></div>
<div class="line"><a id="l00887" name="l00887"></a><span class="lineno">  887</span>    });</div>
<div class="line"><a id="l00888" name="l00888"></a><span class="lineno">  888</span>  }</div>
<div class="line"><a id="l00889" name="l00889"></a><span class="lineno">  889</span>  <span class="keywordflow">else</span></div>
<div class="line"><a id="l00890" name="l00890"></a><span class="lineno">  890</span>  {</div>
<div class="line"><a id="l00891" name="l00891"></a><span class="lineno">  891</span>    <span class="comment">/* Simpler case; no race; so no strand to use.  Keeping comments light.</span></div>
<div class="line"><a id="l00892" name="l00892"></a><span class="lineno">  892</span><span class="comment">     * @todo Subtlety: There&#39;s no race, so in effect on_async_wait_user_loop() does some non-blocking stuff and</span></div>
<div class="line"><a id="l00893" name="l00893"></a><span class="lineno">  893</span><span class="comment">     * executes on_result() -- which actually post()s, through the proper executor, onto *async_task_engine().</span></div>
<div class="line"><a id="l00894" name="l00894"></a><span class="lineno">  894</span><span class="comment">     * If Event_set::async_wait() had a variant (maybe asio::Event_set::async_wait()?) that is a boost.asio-compatible</span></div>
<div class="line"><a id="l00895" name="l00895"></a><span class="lineno">  895</span><span class="comment">     * async-op, in that it respects any associated executor for its completion handler, then it would be arguably</span></div>
<div class="line"><a id="l00896" name="l00896"></a><span class="lineno">  896</span><span class="comment">     * a worth-while goal (for perf/to reduce asynchronicity) to grab the associated executor from the user&#39;s</span></div>
<div class="line"><a id="l00897" name="l00897"></a><span class="lineno">  897</span><span class="comment">     * original completion handler and apply it to the arg given to the async_wait().  The to-do is fairly ambitious,</span></div>
<div class="line"><a id="l00898" name="l00898"></a><span class="lineno">  898</span><span class="comment">     * definitely, but I (ygoldfel) leave it in as food for thought.  Note, though, that I am not suggesting</span></div>
<div class="line"><a id="l00899" name="l00899"></a><span class="lineno">  899</span><span class="comment">     * we do it in the timeout-race case above, as that involves scheduling a parallel timer... the implications of</span></div>
<div class="line"><a id="l00900" name="l00900"></a><span class="lineno">  900</span><span class="comment">     * letting their executor (strand, or who knows what else) control our internal algorithm -- too risky/unclear. */</span></div>
<div class="line"><a id="l00901" name="l00901"></a><span class="lineno">  901</span>    event_set-&gt;async_wait([sock, on_async_wait_user_loop = std::move(on_async_wait_user_loop)]</div>
<div class="line"><a id="l00902" name="l00902"></a><span class="lineno">  902</span>                            (<span class="keywordtype">bool</span> interrupted) <span class="keyword">mutable</span></div>
<div class="line"><a id="l00903" name="l00903"></a><span class="lineno">  903</span>    {</div>
<div class="line"><a id="l00904" name="l00904"></a><span class="lineno">  904</span>      <span class="comment">// No need to worry about making it serial with anything else.</span></div>
<div class="line"><a id="l00905" name="l00905"></a><span class="lineno">  905</span>      post(*sock-&gt;async_task_engine(), [interrupted,</div>
<div class="line"><a id="l00906" name="l00906"></a><span class="lineno">  906</span>                                        on_async_wait_user_loop = std::move(on_async_wait_user_loop)]</div>
<div class="line"><a id="l00907" name="l00907"></a><span class="lineno">  907</span>                                         () <span class="keyword">mutable</span></div>
<div class="line"><a id="l00908" name="l00908"></a><span class="lineno">  908</span>      {</div>
<div class="line"><a id="l00909" name="l00909"></a><span class="lineno">  909</span>        on_async_wait_user_loop(interrupted);</div>
<div class="line"><a id="l00910" name="l00910"></a><span class="lineno">  910</span>      });</div>
<div class="line"><a id="l00911" name="l00911"></a><span class="lineno">  911</span>    });</div>
<div class="line"><a id="l00912" name="l00912"></a><span class="lineno">  912</span>  }</div>
<div class="line"><a id="l00913" name="l00913"></a><span class="lineno">  913</span>} <span class="comment">// Node::async_op()</span></div>
<div class="line"><a id="l00914" name="l00914"></a><span class="lineno">  914</span> </div>
<div class="line"><a id="l00915" name="l00915"></a><span class="lineno">  915</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Rep, <span class="keyword">typename</span> Period, <span class="keyword">typename</span> Handler&gt;</div>
<div class="line"><a id="l00916" name="l00916"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1asio_1_1Node.html#a97d21b9a18651cd234589f3b0b6d2971">  916</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#a97d21b9a18651cd234589f3b0b6d2971">Node::async_connect</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Remote__endpoint.html">Remote_endpoint</a>&amp; to,</div>
<div class="line"><a id="l00917" name="l00917"></a><span class="lineno">  917</span>                         <span class="keyword">const</span> Handler&amp; on_result,</div>
<div class="line"><a id="l00918" name="l00918"></a><span class="lineno">  918</span>                         <span class="keyword">const</span> boost::chrono::duration&lt;Rep, Period&gt;&amp; max_wait,</div>
<div class="line"><a id="l00919" name="l00919"></a><span class="lineno">  919</span>                         <span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket__options.html">Peer_socket_options</a>* opts)</div>
<div class="line"><a id="l00920" name="l00920"></a><span class="lineno">  920</span>{</div>
<div class="line"><a id="l00921" name="l00921"></a><span class="lineno">  921</span>  <span class="keyword">using </span>boost::asio::buffer;</div>
<div class="line"><a id="l00922" name="l00922"></a><span class="lineno">  922</span> </div>
<div class="line"><a id="l00923" name="l00923"></a><span class="lineno">  923</span>  <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#aecac8b38cd35267b1af57e2443a55ea0">async_connect_impl</a>(to, max_wait,</div>
<div class="line"><a id="l00924" name="l00924"></a><span class="lineno">  924</span>                     buffer(&amp;<a class="code hl_variable" href="classflow_1_1net__flow_1_1Node.html#ab13749ccdf4ab44445f21c77296ffa13">S_DEFAULT_CONN_METADATA</a>, <span class="keyword">sizeof</span>(<a class="code hl_variable" href="classflow_1_1net__flow_1_1Node.html#ab13749ccdf4ab44445f21c77296ffa13">S_DEFAULT_CONN_METADATA</a>)),</div>
<div class="line"><a id="l00925" name="l00925"></a><span class="lineno">  925</span>                     opts,</div>
<div class="line"><a id="l00926" name="l00926"></a><span class="lineno">  926</span>                     <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#ad0b99ea857df0cbbf2b26f6c84e8863a">handler_func</a>(on_result));</div>
<div class="line"><a id="l00927" name="l00927"></a><span class="lineno">  927</span>}</div>
<div class="line"><a id="l00928" name="l00928"></a><span class="lineno">  928</span> </div>
<div class="line"><a id="l00929" name="l00929"></a><span class="lineno">  929</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handler&gt;</div>
<div class="line"><a id="l00930" name="l00930"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1asio_1_1Node.html#a7ee695d173c035d106ea7a9d078de3b9">  930</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#a97d21b9a18651cd234589f3b0b6d2971">Node::async_connect</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Remote__endpoint.html">Remote_endpoint</a>&amp; to,</div>
<div class="line"><a id="l00931" name="l00931"></a><span class="lineno">  931</span>                         <span class="keyword">const</span> Handler&amp; on_result,</div>
<div class="line"><a id="l00932" name="l00932"></a><span class="lineno">  932</span>                         <span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket__options.html">Peer_socket_options</a>* opts)</div>
<div class="line"><a id="l00933" name="l00933"></a><span class="lineno">  933</span>{</div>
<div class="line"><a id="l00934" name="l00934"></a><span class="lineno">  934</span>  <span class="keyword">using </span>boost::asio::buffer;</div>
<div class="line"><a id="l00935" name="l00935"></a><span class="lineno">  935</span> </div>
<div class="line"><a id="l00936" name="l00936"></a><span class="lineno">  936</span>  <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#aecac8b38cd35267b1af57e2443a55ea0">async_connect_impl</a>(to, Fine_duration::max(),</div>
<div class="line"><a id="l00937" name="l00937"></a><span class="lineno">  937</span>                     buffer(&amp;<a class="code hl_variable" href="classflow_1_1net__flow_1_1Node.html#ab13749ccdf4ab44445f21c77296ffa13">S_DEFAULT_CONN_METADATA</a>, <span class="keyword">sizeof</span>(<a class="code hl_variable" href="classflow_1_1net__flow_1_1Node.html#ab13749ccdf4ab44445f21c77296ffa13">S_DEFAULT_CONN_METADATA</a>)),</div>
<div class="line"><a id="l00938" name="l00938"></a><span class="lineno">  938</span>                     opts,</div>
<div class="line"><a id="l00939" name="l00939"></a><span class="lineno">  939</span>                     <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#ad0b99ea857df0cbbf2b26f6c84e8863a">handler_func</a>(on_result));</div>
<div class="line"><a id="l00940" name="l00940"></a><span class="lineno">  940</span>}</div>
<div class="line"><a id="l00941" name="l00941"></a><span class="lineno">  941</span> </div>
<div class="line"><a id="l00942" name="l00942"></a><span class="lineno">  942</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Rep, <span class="keyword">typename</span> Period, <span class="keyword">typename</span> Handler&gt;</div>
<div class="line"><a id="l00943" name="l00943"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1asio_1_1Node.html#af8ae97d499f6de21140b89218e52fc4c">  943</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#af8ae97d499f6de21140b89218e52fc4c">Node::async_connect_with_metadata</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Remote__endpoint.html">Remote_endpoint</a>&amp; to,</div>
<div class="line"><a id="l00944" name="l00944"></a><span class="lineno">  944</span>                                       <span class="keyword">const</span> Handler&amp; on_result,</div>
<div class="line"><a id="l00945" name="l00945"></a><span class="lineno">  945</span>                                       <span class="keyword">const</span> boost::chrono::duration&lt;Rep, Period&gt;&amp; max_wait,</div>
<div class="line"><a id="l00946" name="l00946"></a><span class="lineno">  946</span>                                       <span class="keyword">const</span> boost::asio::const_buffer&amp; serialized_metadata,</div>
<div class="line"><a id="l00947" name="l00947"></a><span class="lineno">  947</span>                                       <span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket__options.html">Peer_socket_options</a>* opts)</div>
<div class="line"><a id="l00948" name="l00948"></a><span class="lineno">  948</span>{</div>
<div class="line"><a id="l00949" name="l00949"></a><span class="lineno">  949</span>  <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#aecac8b38cd35267b1af57e2443a55ea0">async_connect_impl</a>(to, max_wait, serialized_metadata,</div>
<div class="line"><a id="l00950" name="l00950"></a><span class="lineno">  950</span>                     opts,</div>
<div class="line"><a id="l00951" name="l00951"></a><span class="lineno">  951</span>                     <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#ad0b99ea857df0cbbf2b26f6c84e8863a">handler_func</a>(on_result));</div>
<div class="line"><a id="l00952" name="l00952"></a><span class="lineno">  952</span>}</div>
<div class="line"><a id="l00953" name="l00953"></a><span class="lineno">  953</span> </div>
<div class="line"><a id="l00954" name="l00954"></a><span class="lineno">  954</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handler&gt;</div>
<div class="line"><a id="l00955" name="l00955"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1asio_1_1Node.html#a5352db9d04c9d1e87b0cae848d0a5a90">  955</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#af8ae97d499f6de21140b89218e52fc4c">Node::async_connect_with_metadata</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Remote__endpoint.html">Remote_endpoint</a>&amp; to,</div>
<div class="line"><a id="l00956" name="l00956"></a><span class="lineno">  956</span>                                       <span class="keyword">const</span> Handler&amp; on_result,</div>
<div class="line"><a id="l00957" name="l00957"></a><span class="lineno">  957</span>                                       <span class="keyword">const</span> boost::asio::const_buffer&amp; serialized_metadata,</div>
<div class="line"><a id="l00958" name="l00958"></a><span class="lineno">  958</span>                                       <span class="keyword">const</span> <a class="code hl_struct" href="structflow_1_1net__flow_1_1Peer__socket__options.html">Peer_socket_options</a>* opts)</div>
<div class="line"><a id="l00959" name="l00959"></a><span class="lineno">  959</span>{</div>
<div class="line"><a id="l00960" name="l00960"></a><span class="lineno">  960</span>  <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#aecac8b38cd35267b1af57e2443a55ea0">async_connect_impl</a>(to, Fine_duration::max(), serialized_metadata,</div>
<div class="line"><a id="l00961" name="l00961"></a><span class="lineno">  961</span>                     opts,</div>
<div class="line"><a id="l00962" name="l00962"></a><span class="lineno">  962</span>                     <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#ad0b99ea857df0cbbf2b26f6c84e8863a">handler_func</a>(on_result));</div>
<div class="line"><a id="l00963" name="l00963"></a><span class="lineno">  963</span>}</div>
<div class="line"><a id="l00964" name="l00964"></a><span class="lineno">  964</span> </div>
<div class="line"><a id="l00965" name="l00965"></a><span class="lineno">  965</span><span class="keyword">template</span>&lt;<span class="keyword">typename</span> Handler&gt;</div>
<div class="line"><a id="l00966" name="l00966"></a><span class="lineno"><a class="line" href="classflow_1_1net__flow_1_1asio_1_1Node.html#ad0b99ea857df0cbbf2b26f6c84e8863a">  966</a></span><a class="code hl_class" href="classflow_1_1Function.html">Node::Handler_func</a> <a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#ad0b99ea857df0cbbf2b26f6c84e8863a">Node::handler_func</a>(Handler&amp;&amp; on_result)</div>
<div class="line"><a id="l00967" name="l00967"></a><span class="lineno">  967</span>{</div>
<div class="line"><a id="l00968" name="l00968"></a><span class="lineno">  968</span>  <span class="keyword">using </span>boost::asio::post;</div>
<div class="line"><a id="l00969" name="l00969"></a><span class="lineno">  969</span>  <span class="keyword">using </span>boost::asio::bind_executor;</div>
<div class="line"><a id="l00970" name="l00970"></a><span class="lineno">  970</span>  <span class="keyword">using </span>boost::asio::get_associated_executor;</div>
<div class="line"><a id="l00971" name="l00971"></a><span class="lineno">  971</span> </div>
<div class="line"><a id="l00972" name="l00972"></a><span class="lineno">  972</span>  <span class="comment">/* This mirrors Peer_socket::handler_func() exactly (just different signature on on_result()).  Comments light.</span></div>
<div class="line"><a id="l00973" name="l00973"></a><span class="lineno">  973</span><span class="comment">   * @todo Maybe there&#39;s a way to generalize this with template param-packs or something. */</span></div>
<div class="line"><a id="l00974" name="l00974"></a><span class="lineno">  974</span> </div>
<div class="line"><a id="l00975" name="l00975"></a><span class="lineno">  975</span>  <span class="keywordflow">return</span> [<span class="keyword">this</span>, on_result = std::move(on_result)]</div>
<div class="line"><a id="l00976" name="l00976"></a><span class="lineno">  976</span>           (<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">Error_code</a>&amp; err_code, <a class="code hl_typedef" href="classflow_1_1net__flow_1_1asio_1_1Peer__socket.html#a3ee868ebd8acd1788a5bed8cf66a349e">Peer_socket::Ptr</a> new_sock)</div>
<div class="line"><a id="l00977" name="l00977"></a><span class="lineno">  977</span>           <span class="keyword">mutable</span></div>
<div class="line"><a id="l00978" name="l00978"></a><span class="lineno">  978</span>  {</div>
<div class="line"><a id="l00979" name="l00979"></a><span class="lineno">  979</span>    <span class="keyword">const</span> <span class="keyword">auto</span> executor = get_associated_executor(on_result);</div>
<div class="line"><a id="l00980" name="l00980"></a><span class="lineno">  980</span>    post(*(<a class="code hl_function" href="classflow_1_1net__flow_1_1asio_1_1Node.html#a778ffa52a73f455142da9497ca10734d">async_task_engine</a>()),</div>
<div class="line"><a id="l00981" name="l00981"></a><span class="lineno">  981</span>         bind_executor(executor,</div>
<div class="line"><a id="l00982" name="l00982"></a><span class="lineno">  982</span>                       [err_code, new_sock, on_result = std::move(on_result)]</div>
<div class="line"><a id="l00983" name="l00983"></a><span class="lineno">  983</span>    {</div>
<div class="line"><a id="l00984" name="l00984"></a><span class="lineno">  984</span>      on_result(err_code, new_sock);</div>
<div class="line"><a id="l00985" name="l00985"></a><span class="lineno">  985</span>    }));</div>
<div class="line"><a id="l00986" name="l00986"></a><span class="lineno">  986</span>  };</div>
<div class="line"><a id="l00987" name="l00987"></a><span class="lineno">  987</span>} <span class="comment">// Node::handler_func()</span></div>
<div class="line"><a id="l00988" name="l00988"></a><span class="lineno">  988</span> </div>
<div class="line"><a id="l00989" name="l00989"></a><span class="lineno">  989</span>} <span class="comment">// namespace flow::net_flow::asio</span></div>
<div class="ttc" id="aasio_2peer__socket_8hpp_html"><div class="ttname"><a href="asio_2peer__socket_8hpp.html">peer_socket.hpp</a></div></div>
<div class="ttc" id="aasio_2server__socket_8hpp_html"><div class="ttname"><a href="asio_2server__socket_8hpp.html">server_socket.hpp</a></div></div>
<div class="ttc" id="aclassflow_1_1Function_html"><div class="ttname"><a href="classflow_1_1Function.html">flow::Function</a></div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00512">common.hpp:512</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Log__context_html_af4db395042b065b00398cd59845dcb4d"><div class="ttname"><a href="classflow_1_1log_1_1Log__context.html#af4db395042b065b00398cd59845dcb4d">flow::log::Log_context::get_logger</a></div><div class="ttdeci">Logger * get_logger() const</div><div class="ttdoc">Returns the stored Logger pointer, particularly as many FLOW_LOG_*() macros expect.</div><div class="ttdef"><b>Definition:</b> <a href="log_8cpp_source.html#l00217">log.cpp:217</a></div></div>
<div class="ttc" id="aclassflow_1_1log_1_1Logger_html"><div class="ttname"><a href="classflow_1_1log_1_1Logger.html">flow::log::Logger</a></div><div class="ttdoc">Interface that the user should implement, passing the implementing Logger into logging classes (Flow'...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l01280">log.hpp:1284</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Event__set_html_a19cc3a286c8a11c986d2a59ec1e39a71"><div class="ttname"><a href="classflow_1_1net__flow_1_1Event__set.html#a19cc3a286c8a11c986d2a59ec1e39a71">flow::net_flow::Event_set::Event_type</a></div><div class="ttdeci">Event_type</div><div class="ttdoc">Type of event or condition of interest supported by class Event_set.</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8hpp_source.html#l00306">event_set.hpp:307</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Net__env__simulator_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Net__env__simulator.html">flow::net_flow::Net_env_simulator</a></div><div class="ttdoc">Objects of this class can be fed to Node to make it internally simulate network conditions like loss,...</div><div class="ttdef"><b>Definition:</b> <a href="net__env__simulator_8hpp_source.html#l00067">net_env_simulator.hpp:70</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Node_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Node.html">flow::net_flow::Node</a></div><div class="ttdoc">An object of this class is a single Flow-protocol networking node, in the sense that: (1) it has a di...</div><div class="ttdef"><b>Definition:</b> <a href="node_8hpp_source.html#l00930">node.hpp:934</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Node_html_ab13749ccdf4ab44445f21c77296ffa13"><div class="ttname"><a href="classflow_1_1net__flow_1_1Node.html#ab13749ccdf4ab44445f21c77296ffa13">flow::net_flow::Node::S_DEFAULT_CONN_METADATA</a></div><div class="ttdeci">static const uint8_t S_DEFAULT_CONN_METADATA</div><div class="ttdoc">Type and value to supply as user-supplied metadata in SYN, if user chooses to use [[a]sync_]connect()...</div><div class="ttdef"><b>Definition:</b> <a href="node_8hpp_source.html#l01400">node.hpp:1400</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Node_html_ad100464cf0126dbbad39bde1c90a774f"><div class="ttname"><a href="classflow_1_1net__flow_1_1Node.html#ad100464cf0126dbbad39bde1c90a774f">flow::net_flow::Node::event_set_create</a></div><div class="ttdeci">Event_set::Ptr event_set_create(Error_code *err_code=0)</div><div class="ttdoc">Creates a new Event_set in Event_set::State::S_INACTIVE state with no sockets/events stored; returns ...</div><div class="ttdef"><b>Definition:</b> <a href="event__set_8cpp_source.html#l00879">event_set.cpp:879</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Peer__socket_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Peer__socket.html">flow::net_flow::Peer_socket</a></div><div class="ttdoc">A peer (non-server) socket operating over the Flow network protocol, with optional stream-of-bytes an...</div><div class="ttdef"><b>Definition:</b> <a href="peer__socket_8hpp_source.html#l00216">peer_socket.hpp:224</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1Server__socket_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1Server__socket.html">flow::net_flow::Server_socket</a></div><div class="ttdoc">A server socket able to listen on a single Flow port for incoming connections and return peer sockets...</div><div class="ttdef"><b>Definition:</b> <a href="server__socket_8hpp_source.html#l00118">server_socket.hpp:126</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1asio_1_1Node_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1asio_1_1Node.html">flow::net_flow::asio::Node</a></div><div class="ttdoc">A subclass of net_flow::Node that adds the ability to easily and directly use net_flow sockets in gen...</div><div class="ttdef"><b>Definition:</b> <a href="asio_2node_8hpp_source.html#l00234">node.hpp:236</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1asio_1_1Node_html_a0cf22e56b3c091645154719eeb49ff4a"><div class="ttname"><a href="classflow_1_1net__flow_1_1asio_1_1Node.html#a0cf22e56b3c091645154719eeb49ff4a">flow::net_flow::asio::Node::async_op</a></div><div class="ttdeci">void async_op(typename Socket::Ptr sock, Function&lt; Non_blocking_func_ret_type(Error_code *)&gt; &amp;&amp;non_blocking_func, Non_blocking_func_ret_type would_block_ret_val, Event_set::Event_type ev_type, const Fine_time_pt &amp;wait_until, Function&lt; void(const Error_code &amp;, Non_blocking_func_ret_type)&gt; &amp;&amp;on_result)</div><div class="ttdoc">Implementation of core asynchronous transfer methods, namely asio::Peer_socket::async_send(),...</div><div class="ttdef"><b>Definition:</b> <a href="asio_2node_8hpp_source.html#l00581">node.hpp:581</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1asio_1_1Node_html_a0e6b29f0ae35a832b0c3c75cf0b577ae"><div class="ttname"><a href="classflow_1_1net__flow_1_1asio_1_1Node.html#a0e6b29f0ae35a832b0c3c75cf0b577ae">flow::net_flow::asio::Node::set_async_task_engine</a></div><div class="ttdeci">void set_async_task_engine(util::Task_engine *target_async_task_engine)</div><div class="ttdoc">Overwrites the value to be returned by next async_task_engine().</div><div class="ttdef"><b>Definition:</b> <a href="asio_2node_8cpp_source.html#l00046">node.cpp:46</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1asio_1_1Node_html_a13e8070f5a4e4300e0138b63694884fc"><div class="ttname"><a href="classflow_1_1net__flow_1_1asio_1_1Node.html#a13e8070f5a4e4300e0138b63694884fc">flow::net_flow::asio::Node::sock_create</a></div><div class="ttdeci">net_flow::Peer_socket * sock_create(const Peer_socket_options &amp;opts) override</div><div class="ttdoc">Implements superclass API.</div><div class="ttdef"><b>Definition:</b> <a href="asio_2peer__socket_8cpp_source.html#l00160">peer_socket.cpp:160</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1asio_1_1Node_html_a5b688a4071b8ad58a776de8d3816b757"><div class="ttname"><a href="classflow_1_1net__flow_1_1asio_1_1Node.html#a5b688a4071b8ad58a776de8d3816b757">flow::net_flow::asio::Node::m_target_task_engine</a></div><div class="ttdeci">util::Task_engine * m_target_task_engine</div><div class="ttdoc">See async_task_engine().</div><div class="ttdef"><b>Definition:</b> <a href="asio_2node_8hpp_source.html#l00575">node.hpp:575</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1asio_1_1Node_html_a63171653725513e198b8baf60c3c1427"><div class="ttname"><a href="classflow_1_1net__flow_1_1asio_1_1Node.html#a63171653725513e198b8baf60c3c1427">flow::net_flow::asio::Node::serv_create</a></div><div class="ttdeci">net_flow::Server_socket * serv_create(const Peer_socket_options *child_sock_opts) override</div><div class="ttdoc">Implements superclass API.</div><div class="ttdef"><b>Definition:</b> <a href="asio_2server__socket_8cpp_source.html#l00115">server_socket.cpp:115</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1asio_1_1Node_html_a778ffa52a73f455142da9497ca10734d"><div class="ttname"><a href="classflow_1_1net__flow_1_1asio_1_1Node.html#a778ffa52a73f455142da9497ca10734d">flow::net_flow::asio::Node::async_task_engine</a></div><div class="ttdeci">util::Task_engine * async_task_engine()</div><div class="ttdoc">Pointer (possibly null) for the flow::util::Task_engine used by any coming async I/O calls and inheri...</div><div class="ttdef"><b>Definition:</b> <a href="asio_2node_8cpp_source.html#l00040">node.cpp:40</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1asio_1_1Node_html_a7db28ab33b1a9afcdcd1884e08f33bee"><div class="ttname"><a href="classflow_1_1net__flow_1_1asio_1_1Node.html#a7db28ab33b1a9afcdcd1884e08f33bee">flow::net_flow::asio::Node::Node</a></div><div class="ttdeci">Node(log::Logger *logger, util::Task_engine *target_async_task_engine, const util::Udp_endpoint &amp;low_lvl_endpoint, Net_env_simulator *net_env_sim=0, Error_code *err_code=0, const Node_options &amp;opts=Node_options())</div><div class="ttdoc">Constructs Node.</div><div class="ttdef"><b>Definition:</b> <a href="asio_2node_8cpp_source.html#l00029">node.cpp:29</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1asio_1_1Node_html_a97d21b9a18651cd234589f3b0b6d2971"><div class="ttname"><a href="classflow_1_1net__flow_1_1asio_1_1Node.html#a97d21b9a18651cd234589f3b0b6d2971">flow::net_flow::asio::Node::async_connect</a></div><div class="ttdeci">void async_connect(const Remote_endpoint &amp;to, const Handler &amp;on_result, const boost::chrono::duration&lt; Rep, Period &gt; &amp;max_wait, const Peer_socket_options *opts=0)</div><div class="ttdoc">The boost.asio asynchronous version of sync_connect(), performing any necessary wait and connection i...</div><div class="ttdef"><b>Definition:</b> <a href="asio_2node_8hpp_source.html#l00916">node.hpp:916</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1asio_1_1Node_html_ad0b99ea857df0cbbf2b26f6c84e8863a"><div class="ttname"><a href="classflow_1_1net__flow_1_1asio_1_1Node.html#ad0b99ea857df0cbbf2b26f6c84e8863a">flow::net_flow::asio::Node::handler_func</a></div><div class="ttdeci">Handler_func handler_func(Handler &amp;&amp;on_result)</div><div class="ttdoc">Returns a functor that essentially performs post() on_result onto *async_task_engine() in a way suita...</div><div class="ttdef"><b>Definition:</b> <a href="asio_2node_8hpp_source.html#l00966">node.hpp:966</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1asio_1_1Node_html_aecac8b38cd35267b1af57e2443a55ea0"><div class="ttname"><a href="classflow_1_1net__flow_1_1asio_1_1Node.html#aecac8b38cd35267b1af57e2443a55ea0">flow::net_flow::asio::Node::async_connect_impl</a></div><div class="ttdeci">void async_connect_impl(const Remote_endpoint &amp;to, const Fine_duration &amp;max_wait, const boost::asio::const_buffer &amp;serialized_metadata, const Peer_socket_options *opts, Handler_func &amp;&amp;on_result)</div><div class="ttdoc">Implementation core of async_connect*() that gets rid of templated or missing arguments thereof.</div><div class="ttdef"><b>Definition:</b> <a href="asio_2peer__socket_8cpp_source.html#l00171">peer_socket.cpp:171</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1asio_1_1Node_html_af8ae97d499f6de21140b89218e52fc4c"><div class="ttname"><a href="classflow_1_1net__flow_1_1asio_1_1Node.html#af8ae97d499f6de21140b89218e52fc4c">flow::net_flow::asio::Node::async_connect_with_metadata</a></div><div class="ttdeci">void async_connect_with_metadata(const Remote_endpoint &amp;to, const Handler &amp;on_result, const boost::chrono::duration&lt; Rep, Period &gt; &amp;max_wait, const boost::asio::const_buffer &amp;serialized_metadata, const Peer_socket_options *opts=0)</div><div class="ttdoc">A combination of async_connect() and connect_with_metadata() (asynchronously blocking connect,...</div><div class="ttdef"><b>Definition:</b> <a href="asio_2node_8hpp_source.html#l00943">node.hpp:943</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1asio_1_1Peer__socket_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1asio_1_1Peer__socket.html">flow::net_flow::asio::Peer_socket</a></div><div class="ttdoc">A net_flow::Peer_socket that adds integration with boost.asio.</div><div class="ttdef"><b>Definition:</b> <a href="asio_2peer__socket_8hpp_source.html#l00038">peer_socket.hpp:41</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1asio_1_1Peer__socket_html_a3ee868ebd8acd1788a5bed8cf66a349e"><div class="ttname"><a href="classflow_1_1net__flow_1_1asio_1_1Peer__socket.html#a3ee868ebd8acd1788a5bed8cf66a349e">flow::net_flow::asio::Peer_socket::Ptr</a></div><div class="ttdeci">boost::shared_ptr&lt; Peer_socket &gt; Ptr</div><div class="ttdoc">Short-hand for shared_ptr to Peer_socket.</div><div class="ttdef"><b>Definition:</b> <a href="asio_2peer__socket_8hpp_source.html#l00046">peer_socket.hpp:46</a></div></div>
<div class="ttc" id="aclassflow_1_1net__flow_1_1asio_1_1Server__socket_html"><div class="ttname"><a href="classflow_1_1net__flow_1_1asio_1_1Server__socket.html">flow::net_flow::asio::Server_socket</a></div><div class="ttdoc">A net_flow::Server_socket that adds integration with boost.asio.</div><div class="ttdef"><b>Definition:</b> <a href="asio_2server__socket_8hpp_source.html#l00038">server_socket.hpp:41</a></div></div>
<div class="ttc" id="aclassflow_1_1util_1_1Shared__ptr__alias__holder_html_aa4f1af88393042e60159a3a67f0accbc"><div class="ttname"><a href="classflow_1_1util_1_1Shared__ptr__alias__holder.html#aa4f1af88393042e60159a3a67f0accbc">flow::util::Shared_ptr_alias_holder&lt; boost::shared_ptr&lt; Event_set &gt; &gt;::Ptr</a></div><div class="ttdeci">boost::shared_ptr&lt; Event_set &gt; Ptr</div><div class="ttdoc">Short-hand for ref-counted pointer to mutable values of type Target_type::element_type (a-la T*).</div><div class="ttdef"><b>Definition:</b> <a href="shared__ptr__alias__holder_8hpp_source.html#l00125">shared_ptr_alias_holder.hpp:125</a></div></div>
<div class="ttc" id="aerror_2error_8hpp_html_ab6b8ed79012c994cfc381e0b92c066fd"><div class="ttname"><a href="error_2error_8hpp.html#ab6b8ed79012c994cfc381e0b92c066fd">FLOW_ERROR_EMIT_ERROR</a></div><div class="ttdeci">#define FLOW_ERROR_EMIT_ERROR(ARG_val)</div><div class="ttdoc">Sets *err_code to ARG_val and logs a warning about the error using FLOW_LOG_WARNING().</div><div class="ttdef"><b>Definition:</b> <a href="error_2error_8hpp_source.html#l00202">error.hpp:202</a></div></div>
<div class="ttc" id="alog_8hpp_html_a325fdd4b5cf0be49b37d3b7b7c29070d"><div class="ttname"><a href="log_8hpp.html#a325fdd4b5cf0be49b37d3b7b7c29070d">FLOW_LOG_INFO</a></div><div class="ttdeci">#define FLOW_LOG_INFO(ARG_stream_fragment)</div><div class="ttdoc">Logs an INFO message into flow::log::Logger *get_logger() with flow::log::Component get_log_component...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l00197">log.hpp:197</a></div></div>
<div class="ttc" id="alog_8hpp_html_affcf2e4c496ce3f42adf981669c623b8"><div class="ttname"><a href="log_8hpp.html#affcf2e4c496ce3f42adf981669c623b8">FLOW_LOG_TRACE</a></div><div class="ttdeci">#define FLOW_LOG_TRACE(ARG_stream_fragment)</div><div class="ttdoc">Logs a TRACE message into flow::log::Logger *get_logger() with flow::log::Component get_log_component...</div><div class="ttdef"><b>Definition:</b> <a href="log_8hpp_source.html#l00227">log.hpp:227</a></div></div>
<div class="ttc" id="anamespaceflow_1_1net__flow_1_1asio_html"><div class="ttname"><a href="namespaceflow_1_1net__flow_1_1asio.html">flow::net_flow::asio</a></div><div class="ttdoc">Contains classes that add boost.asio integration to the main Flow-protocol classes such as net_flow::...</div><div class="ttdef"><b>Definition:</b> <a href="asio_2node_8cpp_source.html#l00024">node.cpp:25</a></div></div>
<div class="ttc" id="anamespaceflow_1_1net__flow_1_1error_html_a18e13de77b119ea0f2be411490859482ab835895723a7d71c964b84e0f0b78c3c"><div class="ttname"><a href="namespaceflow_1_1net__flow_1_1error.html#a18e13de77b119ea0f2be411490859482ab835895723a7d71c964b84e0f0b78c3c">flow::net_flow::error::Code::S_WAIT_USER_TIMEOUT</a></div><div class="ttdeci">@ S_WAIT_USER_TIMEOUT</div><div class="ttdoc">A blocking (sync_) or background-blocking (async_) operation timed out versus user-supplied time limi...</div></div>
<div class="ttc" id="anamespaceflow_1_1net__flow_1_1error_html_a18e13de77b119ea0f2be411490859482ab92ec3b2b78d74acf0fda0786f601df5"><div class="ttname"><a href="namespaceflow_1_1net__flow_1_1error.html#a18e13de77b119ea0f2be411490859482ab92ec3b2b78d74acf0fda0786f601df5">flow::net_flow::error::Code::S_WAIT_INTERRUPTED</a></div><div class="ttdeci">@ S_WAIT_INTERRUPTED</div><div class="ttdoc">A blocking (sync_) or background-blocking (async_) operation was interrupted, such as by a signal.</div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_aa0d10f5a906b3229f48979aa43e9ff7e"><div class="ttname"><a href="namespaceflow_1_1util.html#aa0d10f5a906b3229f48979aa43e9ff7e">flow::util::Scheduled_task_handle</a></div><div class="ttdeci">boost::shared_ptr&lt; Scheduled_task_handle_state &gt; Scheduled_task_handle</div><div class="ttdoc">Black-box type that represents a handle to a scheduled task as scheduled by schedule_task_at() or sch...</div><div class="ttdef"><b>Definition:</b> <a href="sched__task__fwd_8hpp_source.html#l00045">sched_task_fwd.hpp:45</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_aa59354ab408e978c8a7bda1a4706924e"><div class="ttname"><a href="namespaceflow_1_1util.html#aa59354ab408e978c8a7bda1a4706924e">flow::util::Strand</a></div><div class="ttdeci">Task_engine::strand Strand</div><div class="ttdoc">Short-hand for boost.asio strand, an ancillary class that works with Task_engine for advanced task sc...</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00138">util_fwd.hpp:138</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_aad8c8f7335eb892350dc386cb4be397e"><div class="ttname"><a href="namespaceflow_1_1util.html#aad8c8f7335eb892350dc386cb4be397e">flow::util::schedule_task_at</a></div><div class="ttdeci">Scheduled_task_handle schedule_task_at(log::Logger *logger_ptr, const Fine_time_pt &amp;at, bool single_threaded, Task_engine *task_engine, Scheduled_task_handler &amp;&amp;task_body_moved)</div><div class="ttdoc">Identical to schedule_task_from_now() except the time is specified in absolute terms.</div><div class="ttdef"><b>Definition:</b> <a href="sched__task_8hpp_source.html#l00245">sched_task.hpp:245</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_ac3e89a8a271b0ddc76ac2a0ce488dea4"><div class="ttname"><a href="namespaceflow_1_1util.html#ac3e89a8a271b0ddc76ac2a0ce488dea4">flow::util::Task_engine</a></div><div class="ttdeci">boost::asio::io_context Task_engine</div><div class="ttdoc">Short-hand for boost.asio event service, the central class of boost.asio.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00135">util_fwd.hpp:135</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_ad92e68a1b22556f2625292098c0036a2"><div class="ttname"><a href="namespaceflow_1_1util.html#ad92e68a1b22556f2625292098c0036a2">flow::util::scheduled_task_cancel</a></div><div class="ttdeci">bool scheduled_task_cancel(log::Logger *logger_ptr, Scheduled_task_handle task)</div><div class="ttdoc">Attempts to prevent the execution of a previously scheduled (by schedule_task_from_now() or similar) ...</div><div class="ttdef"><b>Definition:</b> <a href="sched__task_8cpp_source.html#l00026">sched_task.cpp:26</a></div></div>
<div class="ttc" id="anamespaceflow_1_1util_html_af1b28edb7bad743c1c77f6b982cc3196"><div class="ttname"><a href="namespaceflow_1_1util.html#af1b28edb7bad743c1c77f6b982cc3196">flow::util::Udp_endpoint</a></div><div class="ttdeci">boost::asio::ip::udp::endpoint Udp_endpoint</div><div class="ttdoc">Short-hand for the UDP endpoint (IP/port) type.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00208">util_fwd.hpp:208</a></div></div>
<div class="ttc" id="anamespaceflow_html_a29eaaa9d0fac4ce87d8b969222dbed09"><div class="ttname"><a href="namespaceflow.html#a29eaaa9d0fac4ce87d8b969222dbed09">flow::Error_code</a></div><div class="ttdeci">boost::system::error_code Error_code</div><div class="ttdoc">Short-hand for a boost.system error code (which basically encapsulates an integer/enum error code and...</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00508">common.hpp:508</a></div></div>
<div class="ttc" id="anamespaceflow_html_a48799f1263cdeedec125be51a3db2b79"><div class="ttname"><a href="namespaceflow.html#a48799f1263cdeedec125be51a3db2b79">flow::Fine_duration</a></div><div class="ttdeci">Fine_clock::duration Fine_duration</div><div class="ttdoc">A high-res time duration as computed from two Fine_time_pts.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00416">common.hpp:416</a></div></div>
<div class="ttc" id="anamespaceflow_html_a9d9cc2eeb10d398cff5591d446b763b8"><div class="ttname"><a href="namespaceflow.html#a9d9cc2eeb10d398cff5591d446b763b8">flow::Fine_time_pt</a></div><div class="ttdeci">Fine_clock::time_point Fine_time_pt</div><div class="ttdoc">A high-res time point as returned by Fine_clock::now() and suitable for precise time math in general.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00413">common.hpp:413</a></div></div>
<div class="ttc" id="anet__flow__fwd_8hpp_html"><div class="ttname"><a href="net__flow__fwd_8hpp.html">net_flow_fwd.hpp</a></div></div>
<div class="ttc" id="anode_8hpp_html"><div class="ttname"><a href="node_8hpp.html">node.hpp</a></div></div>
<div class="ttc" id="asched__task_8hpp_html"><div class="ttname"><a href="sched__task_8hpp.html">sched_task.hpp</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Node__options_html"><div class="ttname"><a href="structflow_1_1net__flow_1_1Node__options.html">flow::net_flow::Node_options</a></div><div class="ttdoc">A set of low-level options affecting a single Flow Node, including Peer_socket objects and other obje...</div><div class="ttdef"><b>Definition:</b> <a href="options_8hpp_source.html#l00448">options.hpp:449</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Peer__socket__options_html"><div class="ttname"><a href="structflow_1_1net__flow_1_1Peer__socket__options.html">flow::net_flow::Peer_socket_options</a></div><div class="ttdoc">A set of low-level options affecting a single Peer_socket.</div><div class="ttdef"><b>Definition:</b> <a href="options_8hpp_source.html#l00035">options.hpp:36</a></div></div>
<div class="ttc" id="astructflow_1_1net__flow_1_1Remote__endpoint_html"><div class="ttname"><a href="structflow_1_1net__flow_1_1Remote__endpoint.html">flow::net_flow::Remote_endpoint</a></div><div class="ttdoc">Represents the remote endpoint of a Flow-protocol connection; identifies the UDP endpoint of the remo...</div><div class="ttdef"><b>Definition:</b> <a href="endpoint_8hpp_source.html#l00092">endpoint.hpp:93</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Mar 28 2025 22:55:35 for Flow by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
